From 83384c6ba93e8c464afc5d4c26113ba44efe915c Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Fri, 4 May 2018 09:32:33 -0400 Subject: [PATCH] Update and rename README.rst to README.md --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 40 ---------------------------------------- 2 files changed, 54 insertions(+), 40 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..0769d69 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +📦 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] + +![image] + +To Do +----- + +- Tests via `$ setup.py test` (if it's concise). + +Pull requests are encouraged! + +More Resources +-------------- + +- [What is setup.py?] on Stack Overflow +- [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/kennethreitz/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 diff --git a/README.rst b/README.rst deleted file mode 100644 index 0dde901..0000000 --- a/README.rst +++ /dev/null @@ -1,40 +0,0 @@ -📦 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! `_ - -.. image:: https://farm1.staticflickr.com/628/33173824932_58add34581_k_d.jpg - - -To Do ------ - -- Tests via ``$ setup.py test`` (if it's concise). - -Pull requests are encouraged! - -More Resources --------------- - -- `What is setup.py? `_ on Stack Overflow -- `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. - -✨🍰✨