fsspec / fsspec/s3fs

Switch to pyproject.toml and modernize development setup?

Open
#602 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1k
Forks
305
Avg merge
22h 37m
Merged PRs (30d)
4

Description

Hey,
Would the project be interested in switching away from the pretty old setup.py environment and instead moving to a pyproject.toml file?

I think also adding pre-commit could be a useful thing. This would mean a setup for a new developer is as simple as:

git clone ...
poetry install
poetry run pytest

If we switch to a lockfile for our dependencies, plus use something like dependabot to get notified whenever a dependency is updated, then we'll be in a good spot for noticing regressions ASAP.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by auditing the existing setup.py and current development workflow. Compare the proposed pyproject.toml, Poetry, pre-commit, pytest, dependency lockfile, and Dependabot setup against the repository's needs. Done means the development setup is migrated and the documented clone, install, and test commands work consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, devops
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.