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

Migrate from setup.py to pyproject.toml #51

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

hadijannat
Copy link

@hadijannat hadijannat commented Jul 20, 2024

This pull request updates the build configuration by modifying the pyproject.toml and setup.py files to include development dependencies and refine the project setup. The goal is to improve the development environment setup and ensure consistent dependency management.

Changes:

  1. pyproject.toml: Updated [build-system] requirements to include setuptools>=45, wheel, and setuptools_scm[toml]>=6.2.
    Added dev optional dependencies section to include pytest, flake8, coverage, and other development tools. Refined project metadata such as version, authors, and dependencies. Improved package data and exclusion configuration.
  2. setup.py: Added extras_require section to define dev dependencies.
    Ensured compatibility with the changes in pyproject.toml.

Procedure:
CI Configuration:
The ci.yml file has been updated to use the dev dependencies during the CI pipeline runs. This ensures that all necessary development tools are installed for testing and code quality checks.
Development Setup:
To set up the development environment locally, run:
pip install .[dev]
This will install the package along with all development dependencies specified in the pyproject.toml and setup.py files.
Impact:
These changes streamline the setup process for new developers and CI environments.
Ensures that the development and testing environments are consistent across different setups.

@hadijannat
Copy link
Author

This pull request updates the build configuration by modifying the pyproject.toml and setup.py files to include development dependencies and refine the project setup. The goal is to improve the development environment setup and ensure consistent dependency management.

Changes:

  1. pyproject.toml: Updated [build-system] requirements to include setuptools>=45, wheel, and setuptools_scm[toml]>=6.2.
    Added dev optional dependencies section to include pytest, flake8, coverage, and other development tools. Refined project metadata such as version, authors, and dependencies. Improved package data and exclusion configuration.
  2. setup.py: Added extras_require section to define dev dependencies.
    Ensured compatibility with the changes in pyproject.toml.

Procedure:
CI Configuration:
The ci.yml file has been updated to use the dev dependencies during the CI pipeline runs. This ensures that all necessary development tools are installed for testing and code quality checks.
Development Setup:
To set up the development environment locally, run:
pip install .[dev]
This will install the package along with all development dependencies specified in the pyproject.toml and setup.py files.
Impact:
These changes streamline the setup process for new developers and CI environments.
Ensures that the development and testing environments are consistent across different setups.

@hadijannat hadijannat self-assigned this Jul 21, 2024
@hadijannat hadijannat mentioned this pull request Jul 24, 2024
@s-heppner s-heppner changed the title Update pyproject toml Migrate from setup.py to pyproject.toml Aug 16, 2024
Copy link

@s-heppner s-heppner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the Python ecosystem moves toward pyproject.toml, it's often recommended to fully migrate from setup.py to pyproject.toml.
As long as there is not concrete reason not to migrate fully, I would suggest to delete the setup.py.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@s-heppner
Copy link

Can you please point this PR to eclipse-basyx/main rather than rwth-iat/main?

@s-heppner
Copy link

Can you also please update your branch, now that eclipse-basyx/basyx-python-sdk#238 has been merged?

@s-heppner
Copy link

Do we still need this PR or can it be closed with respect to the new eclipse-basyx/basyx-python-sdk#290?

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.

2 participants