Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/projectstructure #169

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/projectstructure #169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c84f620
[projectstructure] Use 'python3 -m pip' instead of simply 'pip'
etanot Sep 9, 2021
993fbe0
[projectstructure] Fix punctuations
etanot Sep 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/projectstructure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ next.

$ mkdir myfact

The primary code will be in a file called *fact.py*
The primary code will be in a file called *fact.py*.
::

"myfact module"
Expand All @@ -49,7 +49,7 @@ We also have a *__init__.py* file for the module.
from fact import factorial
__all__ = [factorial, ]

We also added a *README.rst* file. So, the directory structure looks like
We also added a *README.rst* file. So, the directory structure looks like:

::

Expand Down Expand Up @@ -117,7 +117,7 @@ package.

::

$ pip install setuptools wheel
$ python3 -m pip install setuptools wheel


setup.py
Expand Down Expand Up @@ -232,7 +232,7 @@ One can see the output files under *dist* directory.
$ ls dist/
pymfactorial-0.1-py3-none-any.whl pymfactorial-0.1.tar.gz

.. warning:: Remember to use a virtualenv while trying to install the code :)
.. warning:: Remember to use a virtualenv while trying to install the code. :)


Python Package Index (PyPI)
Expand All @@ -242,7 +242,7 @@ Do you remember the **pip** command we are using still now? Ever thought from
where those packages are coming from? The answer is `PyPI <http://pypi..org/>`_.
It is a repository of software for the Python programming language.

For our example, we will use the test server of PyPI which is `https://test.pypi.org/ <https://test.pypi.org/>`_
For our example, we will use the test server of PyPI which is `https://test.pypi.org/ <https://test.pypi.org/>`_.

Creating account
-----------------
Expand All @@ -267,7 +267,7 @@ First, we will have to install **twine** using **pip** (we are using a virtualen

::

$ pip install twine
$ python3 -m pip install twine
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Uploading distributions to https://test.pypi.org/legacy/
Enter your username: kushaldas
Expand All @@ -287,7 +287,7 @@ You can use the following command to install from the test PyPI.

::

$ pip install --index-url https://test.pypi.org/simple/ pymfactorial
$ python3 -m pip install --index-url https://test.pypi.org/simple/ pymfactorial

More readings
==============
Expand Down