Creating a new project¶

Choose a project name¶

Select a name for your project that meets the Python package naming criteria. This name will be used for pip install if you choose to publish your project on PyPI.

Create a GitHub repository¶

Create a repository on GitHub for your new project. Set Repository name to your chosen project name.

Generate new project from template¶

1. In the directory where the new project should be created, run Copier:

   copier copy "gh:smkent/copier-python" ./project_name
   

   Copier will prompt for project information. Answer the prompts to configure your project. When complete, Copier will create your new project in ./project_name.

2. Change to the new project directory:

   cd ./project_name
   

Initialize the project¶

To complete project initialization, run:

poe init

This will:

1. Create the local git repository
2. Install dependencies and git hooks (same as poe setup)
3. Create an initial commit with the newly created project contents
4. Add your GitHub repository as the origin remote (when project_visibility: public)

Push repository to GitHub¶

Push your new project to your GitHub repository:

git push -u origin main

Your project's contents should now be visible on GitHub!