dotlas/api-client-python

[build] Migrate from `setuptools` to `pyproject.toml`

cricksmaidiene opened this issue · 0 comments

About

Currently, our Python packages are managed using setuptools using requirements.txt. However, as per the latest industry standards, we need to move towards using pyproject.toml for package management. This will help us in achieving better compatibility and standardization with other tools and platforms.

The pyproject.toml file will contain all the relevant information related to our package, including dependencies, build requirements, linting configurations and project metadata. This will allow us to have a more standardized approach to package management and simplify the process of building, distributing, and installing our packages.

Process

The migration process will involve the following steps:

  1. Create a pyproject.toml file in the root directory of the project.
  2. Remove setup.py and requirements.txt. Copy the requirements excluding setuptools to pyproject.toml
  3. Update the documentation and build scripts to reflect the new package management approach.
  4. Test the package installation, building, and distribution process to ensure that everything is working as expected.

Reference

The Dotlas Cookiecutter Pypackage already has a standard template for configuring pyproject.toml. All dependencies mentioned in the template may not be necessary, and some can be removed.