Python Like You Mean It

View this content as hosted on Python Like You Mean It

This repository contains the source material for the website Python Like You Mean It. The site is written primarily in Jupytext-markdown (which are eventually transformed into html using nbsphinx). A huge perk of this of this is that you simply need to be familiar with Jupyter notebooks and some markdown syntax in order to contribute to this project!

Asking Questions

Please feel free to post questions (or point out mistakes) about the reading by opening a GitHub issue. Someone from the PLYMI team will respond ASAP! Refer to this reference to see how to include python-codeblocks in your post. This will make it much easier for us to discuss code with each other.

How To Contribute

Contributions to this project are very welcome! I will be sure to credit any/all contributions (unless your want to remain anonymous). Some great ways to help out are to:

proofread
add reading comprehension exercises to existing sections
provide general feedback about the organization of the website, the consistency of the material, etc.
create lengthier standalone problems to serve as holistic examples of how to apply the concepts presented in the reading
recommend new sections to be added to PLYMI

You can either open an issue to provide feedback or point out errors, or you can create a pull request) if you want to submit new/modified materials. The other maintainers of PLYMI and I are happy to help you refine your issues and PRs, so please do not be discouraged if you are new to Git/GitHub.

I have posted a number of "To-Do" tasks in this project's issues page, and I will be adding to these as this project progresses. Included are requests for proofreading and exercises. Please post within an issue if you are working on a to-do item, so multiple people don't end up working on the same task. General feedback on content is also hugely valuable, so feel free to open a new issue to provide your feedback on any of the material.

Here is a nice Markdown "cheat sheet" for looking up how to make tables, code-blocks, etc., in Markdown.

Making a Pull Request

If you want to submit a change to some of the content (e.g. correcting typos), do the following:

Clone this repository
Create a new branch, appropriately named for whatever task you are performing: git checkout -b your_branch_name
In your new branch, make the relevant changes and commit them.
Push your branch: git push origin your_branch_name (you should have permission to do this, if you are added as a "contributor" to this project)
Create a Pull Request from your branch into the master branch.

Building the Site

Important Note: it is strongly preferred that pull requests do not contain changes to the HTML of this site. Rather, it is better if PRs simply contain changes to text files (.rst or .md). A site administrator (@rsokl, @davidmascharka) will be responsible for publishing the actual site-HTML. Thus the following instructions are useful for you to view your changes as they will appear in the site, but you likely need not go through the process of committing the changes to the HTML.

First, clone this repository.

You will need to have anaconda installed on your computer. Then create a new conda environment using the yaml file, plymi.yml, that is located at the top-level of this repository. To create the plymi conda environment, run:

conda env create -f plymi.yml

Once this environment is created activate it. You may need to manually install a couple of dependencies (check if these are installed in your environment first):

pip install sphinx-rtd-theme==0.4.3
pip install jupytext-1.3.0rc1

and install the plymi code base from this repo. Clone the present repository and run:

pip install .

Using this environment, you should now be able to run sphinx to build the html for this site from the source-code. To do this, run the following commands in your Python terminal:

import plymi
plymi.convert_src_to_html("./Python") # point to the dir containing `conf.py`

This will convert all of the "restructured text" (.rst) files to html via sphinx. jupytext is responsible for converting the markdown (.md) files to jupyter notebooks (.ipynb) and then nbsphinx converts these notebooks to html. These html files will be located in Python/_build. You can open the index.html page in your browser to view how the locally-built site looks on your computer.

Note that, if you are introducing a new page to the site or are doing anything that would affect the site's navigation-bar, it is a good idea to delete the _build directory before building the html. This will make sure that sphinx fully generates the pages from scratch.

Publishing HTML for this site

Once you have built the html and have verified that it looks good to you, navigate to the top level of the repository and run:

import plymi
plymi.build_to_doc(".") # point to the top-level dir (contains both `docs/` and `docs_backup`)

This will back-up your current docs directory, and will move the html from _builds to docs. It will also ensure some essential "meta" files, .nojekyll and CNAME are present. The former is required for githubpages to build the site correctly, the latter ensures that the canonical name for the site is pythonlikeyoumeanit.com.