Skip to content

Amsterdam-AI-Team/amsterdam-aiteam-cookiecutter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cookiecutter Amsterdam AI Team

A cookiecutter template maintained by the AI Team of the City of Amsterdam.

Cookiecutter Structure

Installation

git clone https://github.com/Amsterdam-AI-Team/amsterdam_aiteam_cookiecutter.git

Usage

pip install cookiecutter
cookiecutter https://github.com/Amsterdam-AI-Team/amsterdam_aiteam_cookiecutter

You will be prompted to provide the following parameters:

Parameter Description
project_name The name of the project to be displayed as a header of the readme
repo_name The name of the repository. It will be used as name of the root folder
description Short description of the repository to be used in the readme
team "AI" or "intern" - will be used to fill in the clone step in the installation section with the correct github organization (Amsterdam-AI-Team or Amsterdam-Internships)
env_management "pip" or "conda" - will be used to fill in the packages step in the installation section

The cookiecutter will generate several default files and folders. Simply delete the folders you don't need (also from the README) and edit the default requirements.txt or environment.yml to suit your needs.

As a final step, make sure the appropriate branch protection rules are set-up on github:

  • Enabled for main and dev by default
  • For interns / playground repos: dev may be unprotected
  • Review on PR needed by at least one team member

Acknowledgements

This repository was created by Amsterdam Intelligence for the City of Amsterdam.

The content of this repository is inspired by other cookiecutter templates such as the cookiecutter-data-science and cookiecutter-modern-datascience.

We also owe special thanks to fellow data scientists and developers from the City of Amsterdam for the provided input on best practices and guidelines.

Contributing

Feel free to help out! Open an issue, submit a PR or contact us.

License

This project is licensed under the terms of the European Union Public License 1.2 (EUPL-1.2).

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages