Skip to content

Latest commit

 

History

History
144 lines (116 loc) · 5.96 KB

README.md

File metadata and controls

144 lines (116 loc) · 5.96 KB
Raw

SciCookie

CI Python Versions Package Version License Discord

SciCookie is a template developed by Open Science Labs that creates projects from project templates and is based on Cookiecutter. It serves as an initial structure which can be used by beginners as well as full-fledged developers to simplify the project creation process and save considerable amount of time. SciCookie enables projects with an initial layout that includes recommended tools, workflows, and project structure.

SciCookie also offers other features that can enhance the workflow of the development process. Features such as automatic documentation generation, automated testing, and project-specific configuration are part of this. Overall, SciCookie is an efficient tool that gives users the ability to effortlessly create consistent, high-quality projects.

SciCookie is primarily based on the PyOpenSci recommendations who is actively conducting research to determine the tools, libraries, best practices, and workflows utilized by significant scientific Python groups. As a result, this template offers to authors a starting point for their project that adheres with industry standards and can be adjusted to meet particular project requirements.

Features

  • Allows package slug (use _ instead of -)
  • Licenses supported: MIT, BSD 3 Clause, ISC License, Apache Software License 2.0, and GPL 3
  • Documentation engines: mkdocs, sphinx-rst, sphinx-myst, jupyter-boook, quarto
  • Test library: pytest, hypothesis
  • Auto format code tool: black
  • Initial integration with git
  • Support to conda (as base environment) and poetry as packaging and dependency management
  • Support to pre-commit
  • CI with github actions
  • Release workflow with semantic release and github actions
  • Flexible build system selection: Choose between popular build systems like Poetry, Flit, meson-python, Setuptools, PDM, Hatch, Maturin, scikit-build-core or setuptools + pybind11 based on your preference.
  • The structure of the project can use the src layout or flat layout. The “src layout” moving the code that is intended to be importable into a subdirectory. This subdirectory is typically named src. "Flat layout" refers to organising a project's files in a folder or repository so that the various configuration files and import packages are all in the top-level directory. You can read about their differences at https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
  • Finding common security problems in Python code using bandit
  • Offers the option to use pydocstyle for checking compliance with Python documentation conventions.
  • Finds unused code in Python programs using vulture.
  • To automatically detect overly complex code based on cyclomatic complexity, the template gives you the option to use the McCabe library, which is included via flake8.
  • Provides the option to add initial files that allow you to run and orchestrate containers using Docker or Podman in your project.

Quickstart

pip install scicookie

Go to a desired folder to create your new project, for example:

cd ~/dev/my-python-projects

Generate a Python package project:

scicookie

You can also select a specific profile, for example:

scicookie --profile osl

You can also use it with pipx:

pipx run scicookie --profile osl

Development

For testing your changes locally, you can run:

makim tests.lint
makim tests.unit
makim tests.smoke

Maintainers

Acknowledges

Python Software Foundation (PSF)

Open Science Labs has been awarded two grants from the Python Software Foundation (PSF) in April 2023 and January 2024 to enhance SciCookie. The grants were and will be used to implement best practices recommended by pyOpenSci, improve dependencies and configuration settings, and add new features.

We are grateful for the support of the Python Software Foundation. For further details about these grants, you can read more in the blog posts: