Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
pvcraven committed Mar 2, 2020
2 parents c561e3f + 60bda0f commit 2596531
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
4 changes: 4 additions & 0 deletions doc/building_and_deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Requirements
to *develop* your project. The packages required to *run* the project go in
setup.py. This file makes it easy for automatic setup of virtual environment,
and automated builds.
* Python programs often use a virtual environment in a folder (usually named venv).
Python has a lot of other tools like pipenv and more trying to solve this same
problem. Last year, PEP 582 was approved that will use a ``__pypackages__`` directory
that, if it exists, will be used instead of global packages.

Setup
-----
Expand Down
8 changes: 6 additions & 2 deletions doc/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ There are only two required files, and one required directory:
Setup File
----------

* ``/setup.py`` This specifies how your project is to be built, and other
meta information about the project.
* ``/setup.py`` or ``/setup.cgf``. This specifies how your project is to be built, and other
meta information about the project. The ``/setup.py`` seems more common based on my
limited experience, but in 2016 `PEP 518`_ was provisionally accepted which specifies a different
setup method, to be stored in a file called ``setup.cfg``.

.. _PEP 518: https://www.python.org/dev/peps/pep-0518/

Setup File In Detail
--------------------
Expand Down
2 changes: 2 additions & 0 deletions doc/example_directory_tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Example Directory Tree

* |folder| pypi_package_example

* |folder| __pypackages__ |arrow| See PEP 582
* |file| __init__.py

* |folder| tests |arrow| :ref:`testing`
Expand All @@ -53,6 +54,7 @@ Example Directory Tree
* |file| CONTRIBUTING.md |arrow| :ref:`contributing`
* |file| license.rst |arrow| :ref:`license`
* |file| make.bat |arrow| :ref:`make`
* |file| MANIFEST.in |arrow| Use this to specify what should be in a source distribution
* |file| README.rst |arrow| :ref:`readme`
* |file| requirements.txt |arrow| :ref:`requirements`
* |file| setup.py |arrow| :ref:`setup`
Expand Down

0 comments on commit 2596531

Please sign in to comment.