Skip to main content

A small example package

Project description

📦 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!

Installation

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_pkg_chijane-0.0.1.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

py_pkg_chijane-0.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file py_pkg_chijane-0.0.1.tar.gz.

File metadata

  • Download URL: py_pkg_chijane-0.0.1.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.10

File hashes

Hashes for py_pkg_chijane-0.0.1.tar.gz
Algorithm Hash digest
SHA256 b5254a45011ecde26769b79044bdc91ae56eceaf69a7a42e373136f9696c4477
MD5 70a700223e13417466df43253f60d96a
BLAKE2b-256 12f782d7b785b7b3108749127e491ee9b98bdb876bc1e1f2f75f4108f8a33b42

See more details on using hashes here.

File details

Details for the file py_pkg_chijane-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for py_pkg_chijane-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 923af100f8be024f2ca942d2e282ea1738536680612f206f1e0a0aed87ed2705
MD5 20eb33502b9e1c1f4eebf83ae1c950d9
BLAKE2b-256 a9de916192ed5ccb5acf1233682075120be6581a50f53242fa2cd06c63e19909

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page