Skip to content

PythonSanSebastian/hello-python

Repository files navigation

Python Hello World Project

This is a Python project skeleton. Based on Makefile, pipenv, and pytest.

You need pipenv and make installed.

Replace all occurrences of hello_python for your project name. Rename the hello_python folder to your project name. Also PythonSanSebastian to your team name.

Contents

Getting started

Install hello-python with:

pip install hello-python

Using the source code

This project uses pipenv to manage its dependencies and Python environment. You can install it by:

pip install --user pipenv

We recommend using a Python virtual environment for each separate project you do. For that, we suggest using pyenv.

Installation

For production, after you clone this repository, you can install this project plus dependencies with:

cd <clone_dest>
make install

Development

For development you should also install the development dependencies, so run instead:

cd <clone_dest>
make install-dev

This will install all dependencies and this project in development mode.

Testing

We use tox to run the code checkers.

You can run the tests by running tox in the top-level of the project.