Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace ruamel.yaml with PyYAML and Cleanup Imports #73

Merged
merged 5 commits into from
Jul 21, 2023

Conversation

tasansal
Copy link

Closes #70.

  1. Replaced ruamel.yaml with pyyaml since it comes with MkDocs.
  2. Added and applied isort to sort imports
  3. Cleaned up unused imports

I tested it with my documentation, seems to work exactly the same. However not sure how to run your tests.

May I suggest (for the future):

  1. Migrate to pyproject.toml from setup.py
  2. Writing a contributor guide
  3. Implement minimal linting (black + flake8)
  4. Automated tests

Altay Sansal added 2 commits July 20, 2023 17:48
This commit makes several improvements with the goal of enhancing code maintainability. Several import statements have been reorganized for consistency and improved readability. ruamel.yaml package usage has been replaced with yaml PyYAML parsing. This decision was made due to its wider usage, more frequent updates, and better integration. This change also necessitates updates in requirement.txt and setup.py. Unit and UAT tests have been updated to reflect these changes. Mkdoxy version has been bumped from 1.1.5 to 1.1.6 to indicate these changes.
The library 'ruamel.yaml' was removed from the development dependencies in setup.py. This was done because it's no longer necessary for the current version of the application. The application's functionality should remain unaffected.
@JakubAndrysek JakubAndrysek merged commit 74e49db into JakubAndrysek:main Jul 21, 2023
@JakubAndrysek
Copy link
Owner

Thanks much for your quick work. I agree with all your future requests. If you have time I will be glad to merge your pull request. Have a nice day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ruamel.yaml missing from runtime dependencies
2 participants