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 the project to Poetry #443

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

Conversation

HarshCasper
Copy link
Member

Description

This PR:

  • Migrates the project from setuptools to Poetry
  • Make apt changes for the project to build and test on GHA

@codecov
Copy link

codecov bot commented Dec 1, 2021

Codecov Report

Merging #443 (4e57732) into master (f82f52d) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #443   +/-   ##
=========================================
  Coverage   98.588%   98.588%           
=========================================
  Files           29        29           
  Lines         3754      3754           
=========================================
  Hits          3701      3701           
  Misses          53        53           

Impacted file tree graph

@czgdp1807
Copy link
Member

Is poetry.lock file necessary. It has a lot of lines.

@HarshCasper
Copy link
Member Author

Hi @czgdp1807

This is my first attempt at migrating the project to Poetry. Please have a look and let me know the apt changes required. Based on my guesswork, these are the things that would be left:

  • Documenting new changes
  • Publishing the package on poetry
  • Removing setup.py and requirements.txt

@HarshCasper
Copy link
Member Author

Is poetry.lock file necessary. It has a lot of lines.

It is required to lock all the developers to the same set of dependencies as everyone else is using. More about this on the Docs here: https://python-poetry.org/docs/basic-usage/#installing-with-poetrylock

@czgdp1807
Copy link
Member

Can we reduce the dependencies there then? We only use the following. Python should be a minimum of 3.8 from 1.0.1.

sphinx==4.2.0
sphinx-readable-theme==1.3.0
myst_nb==0.13.1
codecov
pytest-cov

@czgdp1807
Copy link
Member

  • Removing setup.py and requirements.txt

Let's keep setuptools there. Some new contributors might not know about poetry so having setuptools will help them. Having poetry is also good for those who want to try something new or not really that into setuptools.

@czgdp1807 czgdp1807 added enhancement New feature or request workflow labels Dec 1, 2021
@czgdp1807
Copy link
Member

I would suggest having two workflows, one using setuptools and the other using poetry. Meanwhile this should also be fixed, #453

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants