Description

Generic Python template for AWE Group

⚙️ Installation

Dependencies

• Sphinx Dependencies, see requirements

Installation Instructions

1. Navigate to the repository folder, using the terminal with commands change-directory cd and path using the tab key will give suggestion for folders

   cd < enter path >

2. Clone the repository, use the git clone, and copy from HTTPS. For the template, this would be:

   git clone https://github.com/awegroup/template-python.git

3. Create a virtual environment:

   Linux or Mac:

   python3 -m venv venv

   Windows:

   python -m venv venv

4. Activate the virtual environment:

   Linux or Mac:

   source venv/bin/activate

   Windows

   .\venv\Scripts\activate

5. Install the required dependencies:

   For users: (using package manager pip)

   pip install .

   For developers:

   pip install -e .[dev]

6. To deactivate the virtual environment:

   deactivate

👀 Usage

import foobar

# returns 'words'
foobar.pluralize('word')

# returns 'geese'
foobar.pluralize('goose')

# returns 'phenomenon'
foobar.singularize('phenomena')

👋 Contributing (optional)

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

⚠️ License and Waiver

Specify the license under which your software is distributed, and include the copyright notice:

Technische Universiteit Delft hereby disclaims all copyright interest in the program “NAME PROGRAM” (one line description of the content or function) written by the Author(s).

Prof.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering

Copyright (c) [YEAR] [NAME SURNAME].

💎 Help and Documentation

AWE Group | Developer Guide