You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
include in the `PyPA sample project <https://github.com/pypa/sampleproject>`_
130
+
included in the `PyPA sample project <https://github.com/pypa/sampleproject>`_.
131
131
132
132
133
133
.. _`setup() args`:
134
134
135
135
setup() args
136
136
------------
137
137
138
-
As mentioned above, The primary feature of ``setup.py`` is that it contains a
138
+
As mentioned above, the primary feature of ``setup.py`` is that it contains a
139
139
global ``setup()`` function. The keyword arguments to this function are how
140
140
specific details of your project are defined.
141
141
@@ -160,7 +160,7 @@ names must:
160
160
161
161
- Consist only of ASCII letters, digits, underscores (``_``), hyphens (``-``),
162
162
and/or periods (``.``), and
163
-
- Start & end with an ASCII letter or digit
163
+
- Start & end with an ASCII letter or digit.
164
164
165
165
Comparison of project names is case insensitive and treats arbitrarily-long
166
166
runs of underscores, hyphens, and/or periods as equal. For example, if you
@@ -204,7 +204,7 @@ description
204
204
description='A sample Python project',
205
205
long_description=long_description,
206
206
207
-
Give a short and long description for you project. These values will be
207
+
Give a short and long description for your project. These values will be
208
208
displayed on :term:`PyPI <Python Package Index (PyPI)>` if you publish your
209
209
project.
210
210
@@ -217,7 +217,7 @@ url
217
217
url='https://github.com/pypa/sampleproject',
218
218
219
219
220
-
Give a homepage url for your project.
220
+
Give a homepage URL for your project.
221
221
222
222
223
223
author
@@ -612,14 +612,14 @@ dependencies declared with "install_requires" and any scripts declared with
612
612
613
613
It's fairly common to also want to install some of your dependencies in editable
614
614
mode as well. For example, supposing your project requires "foo" and "bar", but
615
-
you want "bar" installed from vcs in editable mode, then you could construct a
615
+
you want "bar" installed from VCS in editable mode, then you could construct a
616
616
requirements file like so::
617
617
618
618
-e .
619
619
-e git+https://somerepo/bar.git#egg=bar
620
620
621
621
The first line says to install your project and any dependencies. The second
622
-
line overrides the "bar" dependency, such that it's fulfilled from vcs, not
622
+
line overrides the "bar" dependency, such that it's fulfilled from VCS, not
623
623
PyPI.
624
624
625
625
If, however, you want "bar" installed from a local directory in editable mode, the requirements file should look like this, with the local paths at the top of the file::
@@ -628,7 +628,7 @@ If, however, you want "bar" installed from a local directory in editable mode, t
628
628
-e .
629
629
630
630
Otherwise, the dependency will be fulfilled from PyPI, due to the installation order of the requirements file. For more on requirements files, see the :ref:`Requirements File
631
-
<pip:Requirements Files>` section in the pip docs. For more on vcs installs,
631
+
<pip:Requirements Files>` section in the pip docs. For more on VCS installs,
632
632
see the :ref:`VCS Support <pip:VCS Support>` section of the pip docs.
633
633
634
634
Lastly, if you don't want to install any dependencies at all, you can run::
@@ -647,7 +647,7 @@ Packaging your Project
647
647
648
648
To have your project installable from a :term:`Package Index` like :term:`PyPI
649
649
<Python Package Index (PyPI)>`, you'll need to create a :term:`Distribution
650
-
<Distribution Package>` (aka ":term:`Package <Distribution Package>`") for your
650
+
<Distribution Package>` (aka ":term:`Package <Distribution Package>`") for your
651
651
project.
652
652
653
653
@@ -663,9 +663,9 @@ Minimally, you should create a :term:`Source Distribution <Source Distribution (
663
663
python setup.py sdist
664
664
665
665
666
-
A "source distribution" is unbuilt (i.e, it's not a :term:`Built Distribution`),
666
+
A "source distribution" is unbuilt (i.e. it's not a :term:`Built Distribution`),
667
667
and requires a build step when installed by pip. Even if the distribution is
668
-
pure python (i.e. contains no extensions), it still involves a build step to
668
+
pure Python (i.e. contains no extensions), it still involves a build step to
669
669
build out the installation metadata from ``setup.py``.
670
670
671
671
@@ -677,15 +677,15 @@ package <Built Distribution>` that can be installed without needing to go
677
677
through the "build" process. Installing wheels is substantially faster for the
678
678
end user than installing from a source distribution.
679
679
680
-
If your project is pure python (i.e. contains no compiled extensions) and
680
+
If your project is pure Python (i.e. contains no compiled extensions) and
681
681
natively supports both Python 2 and 3, then you'll be creating what's called a
682
682
:ref:`*Universal Wheel* (see section below) <Universal Wheels>`.
683
683
684
-
If your project is pure python but does not natively support both Python 2 and
684
+
If your project is pure Python but does not natively support both Python 2 and
685
685
3, then you'll be creating a :ref:`"Pure Python Wheel" (see section below) <Pure
686
686
Python Wheels>`.
687
687
688
-
If you project contains compiled extensions, then you'll be creating what's
688
+
If your project contains compiled extensions, then you'll be creating what's
689
689
called a :ref:`*Platform Wheel* (see section below) <Platform Wheels>`.
690
690
691
691
Before you can build wheels for your project, you'll need to install the
@@ -701,7 +701,7 @@ Before you can build wheels for your project, you'll need to install the
701
701
Universal Wheels
702
702
~~~~~~~~~~~~~~~~
703
703
704
-
*Universal Wheels* are wheels that are pure python (i.e. contains no compiled
704
+
*Universal Wheels* are wheels that are pure Python (i.e. contain no compiled
705
705
extensions) and support Python 2 and 3. This is a wheel that can be installed
706
706
anywhere by :ref:`pip`.
707
707
@@ -713,7 +713,7 @@ To build the wheel:
713
713
714
714
You can also permanently set the ``--universal`` flag in "setup.cfg" (e.g., see
0 commit comments