update guide

gabrielfalcao · Jun 3, 2018 · 830ffc5 · 830ffc5
1 parent a07b874
commit 830ffc5
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 63 deletions.
diff --git a/README.rst b/README.rst
@@ -2,5 +2,5 @@ Workshop: From your editor to PyPi
 ==================================
 
 .. image:: https://readthedocs.org/projects/workshop-from-your-editor-to-pypi/badge/?version=latest
-:target: https://workshop-from-your-editor-to-pypi.readthedocs.io/en/latest/?badge=latest
-:alt: Documentation Status
+   :target: https://workshop-from-your-editor-to-pypi.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
diff --git a/docs/source/_static/pyramid.jpg b/docs/source/_static/pyramid.jpg
diff --git a/docs/source/_static/unit-functional.jpg b/docs/source/_static/unit-functional.jpg
diff --git a/docs/source/configure-travis.rst b/docs/source/configure-travis.rst
diff --git a/docs/source/guide.rst b/docs/source/guide.rst
@@ -4,7 +4,7 @@ Step-by-step guide
 ==================
 
 
-.. _guide step 1:
+.. _create service accounts:
 
 1. Create service accounts
 --------------------------
@@ -20,7 +20,7 @@ Below you can find direct links for account creation pages:
 #. `Make a Read-The-Docs account  <https://readthedocs.org/accounts/signup/>`_
 #. `Make a Travis account <https://travis-ci.org/>`_ (requires a github account)
 
-.. _guide step 2:
+.. _install virtualenv:
 
 2. Install virtualenv
 ---------------------
@@ -32,13 +32,49 @@ Below you can find direct links for account creation pages:
 .. seealso:: If you are feeling adventurous, use `pipenv <https://docs.pipenv.org/>`_ a great tool for python development workflow including managing virtualenvs and keeping track of installed packages (Pipfile)
 
 
-.. _guide step 3:
+.. _install cookiecutter:
 
 3. Install cookiecutter
 -----------------------
 
-To speed-up our productivity let's use `cookiecutter <https://cookiecutter.readthedocs.io/en/latest/>`_
+To speed-up our productivity we will use `cookiecutter <https://cookiecutter.readthedocs.io/en/latest/>`_.
 
 .. code:: bash
 
    pip install cookiecutter
+
+
+4. Create your package with cookiecutter
+----------------------------------------
+
+The template is available on github at `gabrielfalcao/cookiecutter-from-editor-to-pypi <https://github.com/gabrielfalcao/cookiecutter-from-editor-to-pypi>`_
+
+Cookiecutter is smart enough to install directly from github, for that
+just run the following command from your ``~/projects`` folder or
+whenever you prefer to keep personal projects.
+
+
+.. code:: bash
+
+   cookiecutter gh:gabrielfalcao/cookiecutter-from-editor-to-pypi
+
+
+.. important:: **Answer carefully** to the interactive questions. Try
+               your best to avoid typos in this step as it might impact
+               many files of your newly-created project.
+
+
+5. Run tests
+------------
+
+.. image:: _static/pyramid.jpg
+.. image:: _static/unit-functional.jpg
+
+In your project root, run:
+
+
+.. code:: bash
+
+   make unit
+   make functional
+   make docs
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,15 +6,14 @@
 Workshop: From Editor to PyPi
 =============================
 
+.. danger:: This documentation is a work-in-progress. Please watch the project on github to receive updates on its repository.
+
 .. toctree::
    :maxdepth: 5
    :caption: Agenda:
 
    programme
    guide
-   pypi-account
+   pypirc-credentials
    configure-setup-py
    next-steps
-
-
-.. warning:: This documentation is a work-in-progress. Please watch the project on github to receive updates on its repository.
diff --git a/docs/source/new-project-with-cookiecutter.rst b/docs/source/new-project-with-cookiecutter.rst
diff --git a/docs/source/pypi-account.rst b/docs/source/pypi-account.rst
diff --git a/docs/source/pypirc-credentials.rst b/docs/source/pypirc-credentials.rst
@@ -0,0 +1,26 @@
+Configuring PyPi for publishing packages
+========================================
+
+.. note:: You will need a PyPi account for publishing your packages. Refer to the :ref:`create service accounts` page in the :ref:`guide` for more information
+
+Head to `pypi.org/account/register <https://pypi.org/account/register/>`__ and create an account.
+
+**Make sure to create a strong password, include special characters.**
+
+
+Write your PyPi credentials to ``.pypirc``
+==========================================
+
+Edit the file ``~/.pypirc`` and add your credentials.
+
+Below is a snippet to make things easier.
+
+.. code:: ini
+
+   [distutils]
+   index-servers =
+       pypi
+
+   [pypi]
+   username:YOUR_USERNAME
+   password:YOUR_PASSWORD