:tocdepth: -1

.. index:: new-project-guide

.. _scikit-package-new-project-header:

=====================================================
How to start a new Python project with scikit-package
=====================================================

.. include:: snippets/scikit-installation.rst

Overview

scikit-package main workflow
-----------------------------

1. Type ``package create`` inside the project directory.

2. Answer the questions as the following -- note that (default) means to hit enter without modifying anything:

.. include:: snippets/package-create-user-inputs.rst

.. _new-project-guide-build-package:

3. Ensure you can build your project
4.
Check your documentation
------------------------

# Build your documentation locally:

.. include:: snippets/doc-build-instruction.rst

Host your project on GitHub
---------------------------

Here, we will not use a PR workflow. Instead, the goal here is to host your project on GitHub.

#. Make sure you have a GitHub account.

#. Visit ``https://github.com/new``.

#. Choose the ``Owner`` and enter the ``Repository name`` and the ``Description``.

#. Set ``none`` under ``Add .gitignore`` and ``Choose a licenese``. We will use the ones generated by ``scikit-package``.

#. Click the ``Create repository`` to green button to create the repository.

#. You will have ``https://github.com/<OWNER>/<project-name>`.

#. Initialize the repository ::

    git init
    git remote add origin https://github.com/bobleesj/test-package.git
    git add .
    git commit -m "skpkg: start a new project with scikit-package"
    git branch -M main
    git push --set-upstream origin main

Hello world

:ref:`Helo <migration-guide-move-files>`