Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 1.47 KB

INSTALL.rst

File metadata and controls

67 lines (41 loc) · 1.47 KB
Raw

Installation

This is primarily a documentation project hosted on Read the Docs. However all the example code is buildable and testable so if you want to examine that then here is how to get the project.

From PyPi

pip install cPyExtPatt

From Source

Choose a directory of your choice, in this case: ~/dev/tmp.

mkdir -p ~/dev/tmp
cd ~/dev/tmp
git clone https://github.com/paulross/PythonExtensionPatterns.git
cd PythonExtensionPatterns

Virtual Environment

Create a Python environment in the directory of your choice, in this case: ~/dev/tmp/PythonExtensionPatterns/venv_3.11 and activate it:

python3.11 -m venv venv_3.11
source venv_3.11/bin/activate

Install the Dependencies

pip install -r requirements.txt

Running the Tests

You now should be able to run the following commands successfully in ~/dev/tmp/PythonExtensionPatterns with your environment activated:

pytest tests/

Building the Documentation

This will build the html and PDF documentation (requires a latex installation):

cd doc/sphinx
make html latexpdf