Tutorial¶

This page contains a complete tutorial on how to create your project.

Step 1: Install poetry¶

To start, we will need to install poetry. The instructions to install poetry can be found here. After installing, it is recommended to run

poetry config virtualenvs.in-project true

which will by default create new virtual environments in ./.venv whenever you create them with poetry init.

Step 2: Install pyenv (Optional)¶

I would recommend to use pyenv for managing your different Python versions. However, if you prefer another method of managing your Python versions, feel free to skip this step and continue to step 3.

The instructions to install pyenv can be found here. The instructions to install poetry can be found here.

Install a version of Python with pyenv. To see a list of available versions, run:

pyenv install --list

Select a version and install it with

pyenv install -v 3.9.7

Replacing 3.9.7 with a version of your choosing.

Step 3: Generate your project¶

First, navigate to the directory in which you want the project to be created. Then, we need to install fulmo-cookiecutter-poetry with the following command:

pip install fulmo-cookiecutter-poetry

Within the directory in which you want to create your project, run:

fcp

For an explanation of the prompt arguments, see Prompt Arguments.

An alternative to the steps above would be to install cookiecutter and directly pass the URL to Github repository to the cookiecutter command:

pip install fulmo-cookiecutter-poetry
cookiecutter https://github.com/jexio/fulmo-cookiecutter-poetry.git

Step 4: Set up your Github repository¶

Create an empty new repository on Github. Give it a name that only contains alphanumeric characters and optionally -. DO NOT check any boxes under the option Initialize this repository with.

Step 5: Upload your project to Github¶

Run the following commands, replacing <project-name> with the name that you also gave the Github repository and <github_username> with your Github username.

cd <project_name>
git init -b main
git add .
git commit -m "Init commit"
git remote add origin git@github.com:<github_username>/<project_name>.git
git push -u origin main

Step 6: Activate your environment¶

If you are using pyenv, you might want to set the local python version to be used:

pyenv local x.y.z

Install and activate the poetry environment by running:

make install
poetry shell

If you enabled code coverage with codecov for your project, you should sign up with your GitHub account at codecov.io

Step 8: Configure your repository secrets¶

If you want to deploy your project to Pypi using the Github Actions, you will have to set some repository secrets. For instructions on how to do that, see here for PyPi.

Step 9: Create a new release¶

To trigger a new release, navigate to your repository on GitHub, click Releases on the right, and then select Draft a new release. If you fail to find the button, you could also directly visit https://github.com/<username>/<repository-name>/releases/new.

Give your release a title, and add a new tag in the form *.*.* where the *'s are alphanumeric. To finish, press Publish release.

Step 10: Enable your documentation¶

In your repository, navigate to Settings > Code and Automation > Pages. If you succesfully created a new release, you should see a notification saying Your site is ready to be published at https://<github_username>.github.io/<project_name>/.

To finalize deploying your documentation, under Source, select the branch gh-pages.

Step 11: You're all set!¶

That's it! I hope this repository saved you a lot of manual configuration. If you have any improvement suggestions, feel free to raise an issue or open a PR on Github!