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

Refactor Versioning, documentation and CI workflows #18

Merged
merged 9 commits into from
Mar 18, 2024

Conversation

armando-palacio
Copy link
Owner

This pull request implements various enhancements and optimizations to the project setup and maintenance:

  1. Refactored Versioning and Documentation Handling:

    • Introduced a __version__ variable in __init__.py.
    • Updated Python requirements to >3.8 in setup.py file.
    • Removed redundant titles from README.md.
  2. Simplified Version Management:

    • Removed VERSION.txt, updating version directly in __init__.py.
  3. Enhanced Documentation Handling:

    • Modified sphinx conf.py to retrieve version from opticmlib.
  4. Code Cleanup:

    • Removed unnecessary imports and unused code.
  5. Improved Setup.py Requirements Handling:

    • Updated setup.py to include requirements using include_package_data=True argument, along with the addition of a MANIFEST.in file.
  6. Enhanced CI Process:

    • Added checks for unittests, package build, and sphinx docs to CI.
    • Integrated release and publish workflows into test-build-release-publish.yml.
  7. Documentation Improvement:

    • Added docstrings to get_long_description and get_requirements functions in setup.py .

…obtained.

- define __version__ variable on __init__.py
- python requirements is now >3.8.
- delete some useless titles on README.md
From now on, the version will be modified directly in the __init__.py of opticomlib
the requirements were now included using the `include_package_data=True` argument on setup() function and including a MANIFEST.in file in the root of the project
1. when PR now it will check for unittests, build package process and build sphinx documentation process.
2. releases and publish to pypi workflows was integrated in the same file called `test-build-release-publish.yml`.
3. little changes in jobs name.
4. all workflows now use `python-version=3.10`.
@armando-palacio armando-palacio added documentation Improvements or additions to documentation CI For changes related to Continuous Integration with Github Actions labels Mar 18, 2024
@armando-palacio armando-palacio self-assigned this Mar 18, 2024
@armando-palacio armando-palacio merged commit c8484a6 into main Mar 18, 2024
3 checks passed
@armando-palacio armando-palacio deleted the handle-version branch March 18, 2024 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI For changes related to Continuous Integration with Github Actions documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant