https://github.com/data-exp-lab/ytcookiecutter

a cookiecutter template for yt
https://github.com/data-exp-lab/ytcookiecutter

Last synced: about 1 year ago
JSON representation

a cookiecutter template for yt

• Host: GitHub
• URL: https://github.com/data-exp-lab/ytcookiecutter
• Owner: data-exp-lab
• License: bsd-3-clause
• Created: 2021-10-20T19:34:26.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-24T15:20:26.000Z (about 4 years ago)
• Last Synced: 2023-03-05T09:52:11.260Z (over 3 years ago)
• Language: Python
• Size: 546 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============

ytcookiecutter

===============

This is an experimental Cookiecutter_ template for yt-related development, including rapid prototyping of new frontends.

* GitHub repo: https://github.com/data-exp-lab/ytcookiecutter/

* Documentation: https://ytcookiecutter.readthedocs.io/

* Free software: BSD license

Features

--------

In addition to the `standard cookiecutter template `_ features, this template includes:

* frontend scaffolding

* github actions for build tests

* pre-commit configuration

* auto-generation of requirements files with yt-related dependencies

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter

Build Status

-------------

Quickstart

----------

To use, first install cookiecutter:

    pip install cookiecutter

and then to use this template:

    cookiecutter https://github.com/data-exp-lab/ytcookiecutter.git

this will generate a new package directory. TO DO: write more.

Maintainer Notes

----------------

This repository is itself a package, `ytcookiecutter`, that includes some tools for auto-generation of cookiecutter templates. It can be installed with

    $ pip install -e .

after which you can (re)-generate templates using the command line. To view the options:

    $ ytcookiecutter -h

and running

    $ ytcookiecutter stream-template

will build the template for the stream frontend data loaders.