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

add support for pip install #13

Merged
merged 1 commit into from
Jan 15, 2024

Conversation

branchvincent
Copy link
Contributor

Fixes #10

This add a pyproject.toml file (the successor to setup.py, favoring static metadata and allowing different "backends" beyond setuptools) so users can pip install it:

$ python3 -m venv .venv
$ .venv/bin/pip install git+https://github.com/branchvincent/littlecheck@pyproject
$ .venv/bin/littlecheck --help
usage: littlecheck [-h] [-s SUBSTITUTE] [-p] [--force-color] file [file ...]

littlecheck: command line tool tester.
...

As for the build-backend, I've chosen flit_core from the packaging guide because it is very simple and doesn't require custom configuration (unlike setuptools)

@zanchey zanchey merged commit ce67182 into ridiculousfish:master Jan 15, 2024
2 checks passed
@zanchey
Copy link
Collaborator

zanchey commented Jan 15, 2024

Thanks, that's a good step. Possibly we should look at PyPA submission?

@branchvincent branchvincent deleted the pyproject branch June 15, 2024 04:34
@branchvincent
Copy link
Contributor Author

branchvincent commented Jun 15, 2024

@zanchey sorry for the long delay, the name is available: https://pypi.org/search/?q=littlecheck

if you wanted to publish, it should be as simple as (assuming you have a PyPI account):

pipx run build
pipx run twine upload dist/*

Happy to help add a publishing step to CI if that would be useful

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.

Be a normal python thing: setup.py
2 participants