diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2015-11-27 12:43:20 -0500 |
---|---|---|
committer | Jason R. Coombs <jaraco@jaraco.com> | 2015-11-27 12:43:20 -0500 |
commit | 05f2a7dd72b5fbbd352b8dee45feb8ab8d91048b (patch) | |
tree | 15ae6c492268102ce55a2a6b46e9bbba2b437de2 /docs | |
parent | 751e7f82bd14a254d2467fe64975202d5bfc88be (diff) | |
download | python-setuptools-bitbucket-05f2a7dd72b5fbbd352b8dee45feb8ab8d91048b.tar.gz |
Add a bit more detail about the setup script and what to expect. Fixes #466.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/setuptools.txt | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt index e2753cba..d6a62de8 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -112,10 +112,16 @@ the distutils. Here's a minimal setup script using setuptools:: ) As you can see, it doesn't take much to use setuptools in a project. -Just by doing the above, this project will be able to produce eggs, upload to +Run that script in your project folder, alongside the Python packages +you have developed. + +Invoke that script to produce eggs, upload to PyPI, and automatically include all packages in the directory where the setup.py lives. See the `Command Reference`_ section below to see what -commands you can give to this setup script. +commands you can give to this setup script. For example, +to produce a source distribution, simply invoke:: + + python setup.py sdist Of course, before you release your project to PyPI, you'll want to add a bit more information to your setup script to help people find or learn about your |