https://github.com/navdeep-G/setup.py

📦 A Human's Ultimate Guide to setup.py.
https://github.com/navdeep-G/setup.py

distutils forumans guide kennethreitz packaging python setuptools

Last synced: 10 days ago
JSON representation

📦 A Human's Ultimate Guide to setup.py.

• Host: GitHub
• URL: https://github.com/navdeep-G/setup.py
• Owner: navdeep-G
• License: mit
• Created: 2017-08-28T15:54:23.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T17:57:56.000Z (over 1 year ago)
• Last Synced: 2024-10-29T15:30:59.639Z (10 days ago)
• Topics: distutils, forumans, guide, kennethreitz, packaging, python, setuptools
• Language: Python
• Homepage: https://github.com/navdeep-G/setup.py/blob/master/setup.py
• Size: 66.4 KB
• Stars: 5,078
• Watchers: 94
• Forks: 567
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• StarryDivineSky - navdeep-G/setup.py

README

        
📦 setup.py (for humans)

=======================

This repo exists to provide [an example setup.py] file, that can be used

to bootstrap your next Python project. It includes some advanced

patterns and best practices for `setup.py`, as well as some

commented–out nice–to–haves.

For example, this `setup.py` provides a `$ python setup.py upload`

command, which creates a *universal wheel* (and *sdist*) and uploads

your package to [PyPi] using [Twine], without the need for an annoying

`setup.cfg` file. It also creates/uploads a new git tag, automatically.

In short, `setup.py` files can be daunting to approach, when first

starting out — even Guido has been heard saying, "everyone cargo cults

thems". It's true — so, I want this repo to be the best place to

copy–paste from :)

[Check out the example!][an example setup.py]

Installation

-----

```bash

cd your_project

# Download the setup.py file:

#  download with wget

wget https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py -O setup.py

#  download with curl

curl -O https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py

```

To Do

-----

-   Tests via `$ setup.py test` (if it's concise).

Pull requests are encouraged!

More Resources

--------------

-   [What is setup.py?] on Stack Overflow

-   [Official Python Packaging User Guide](https://packaging.python.org)

-   [The Hitchhiker's Guide to Packaging]

-   [Cookiecutter template for a Python package]

License

-------

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or

distribute this software, either in source code form or as a compiled

binary, for any purpose, commercial or non-commercial, and by any means.

  [an example setup.py]: https://github.com/navdeep-G/setup.py/blob/master/setup.py

  [PyPi]: https://docs.python.org/3/distutils/packageindex.html

  [Twine]: https://pypi.python.org/pypi/twine

  [image]: https://farm1.staticflickr.com/628/33173824932_58add34581_k_d.jpg

  [What is setup.py?]: https://stackoverflow.com/questions/1471994/what-is-setup-py

  [The Hitchhiker's Guide to Packaging]: https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/creation.html

  [Cookiecutter template for a Python package]: https://github.com/audreyr/cookiecutter-pypackage