Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
README.md 1.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • Dorian Turba's avatar
    Dorian Turba committed
    # Cookiecutter for Python projects
    
    Managing the initial setup and boilerplate code for Python Package projects can be a repetitive and
    time-consuming task. To streamline this process, we've created a Cookiecutter template that
    automates the creation of such projects. This template is designed to save you time and effort,
    allowing you to focus on building the core functionality of your project.
    
    ## Getting Started
    
    To get started with our Cookiecutter template, follow these simple steps:
    
    ### 1. Install Cookiecutter
    
    Before you can use our template, ensure you have Cookiecutter installed. You can install it using
    the following command:
    
    ```bash
    pip install cookiecutter
    ```
    
    ### 2. Use the Cookiecutter Template
    
    Navigate to the directory where you intend to create your new project and run the following command:
    
    ```bash
    
    cookiecutter https://lab.frogg.it/swepy/cookiecutter/python-package.git
    
    Dorian Turba's avatar
    Dorian Turba committed
    ```
    
    This command will guide you through a series of prompts to gather information about your project and
    set up the necessary files and structure.
    
    ## Tests
    
    You can run pytest from the root directory while indicating the test path:
    
    ```bash
    pytest tests --no-header --no-summary -q
    ```
    
    ## Simplify with User Configuration
    
    Entering the same information repeatedly can be tedious. To further streamline the project creation
    process, you can utilize a user configuration file.
    
    1. Create a file named `~/.cookiecutterrc` in your home directory.
    2. Add your default configuration values to this file using YAML format. For example:
    
    ```yaml
    default_context:
        author_fullname: "Your Name"
        author_email: "your@email.com"
    ```