GitXplorerGitXplorer
k

minimal-setup.py-project

public
2 stars
0 forks
0 issues

Commits

List of commits on branch main.
Verified
d9eacd0d65fffe70ff3d130fb11663436954c5e8

remove <4 in python_requires

kkaczmarj committed 2 years ago
Verified
0903df8bfcea1120759f16bc857873d59ecf740a

add instructions to build and upload packge

kkaczmarj committed 3 years ago
Verified
bd586003a85d894e33fba89ee1d33e08e4c3e4e7

add entry_point to setup.py (#1)

kkaczmarj committed 3 years ago
Unverified
5d293257cc7eab867ba0e845cac2219f5e2886c5

add instructions to install from github

kkaczmarj committed 3 years ago
Unverified
d8a8d895d1ed12cf2d1338e4f44f145ef41c9c4f

initial commit

kkaczmarj committed 3 years ago

README

The README file for this repository.

meow

This is an example of how to use setup.py to make a Python package installable.

Helpful links for setup.py things

Install from GitHub repository

At least two options:

  1. Install using the .tar.gz of the project:

    pip install https://github.com/kaczmarj/minimal-setup.py-project/tarball/main
    
  2. Install using git (requires git to be installed):

    pip install git+https://github.com/kaczmarj/minimal-setup.py-project
    

Upload package to pypi.org

Note: See the official documentation for complete information.

Uploading the package to pypi.org makes it possible for others to pip install NAME the package.

This requires the packages build and twine: pip install build twine.

  1. Build the package.

    python -m build
    
  2. Upload the package. First, upload it to pypi's testing site. You can check if things look OK there.

    python3 -m twine upload --repository testpypi dist/*
    

    Then you can install it from the testing site, to make sure it works. Do this in a virtual environment.

    python3 -m venv venv-test
    source ./venv-test/bin/activate
    python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps meow-YOUR-USERNAME-HERE
    python3 -c "import meow"
    meow
    # Run any other tests you want.
    # Clean up the venv when you're finished.
    rm -r venv-test/
    
  3. Once you're satisfied, upload it to the actual pypi site.

    python3 -m twine upload dist/*
    

Choosing a license

See https://choosealicense.com/.