Giter Club home page Giter Club logo

template's Introduction

Repository Template

Checklist after creating a new repository from this template:

  • Go through pyproject.toml and fill in the PLACEHOLDER's. Note that:
    • GH_TOKEN is only needed if you want to trigger a semantic release locally. It is not needed for doing a release on GitHub Actions (as per semantic_release.yaml).
    • If you wish to publish to Test PyPI, ensure that name under [project] is available on Test PyPI.
  • If you wish to publish to Test PyPI, as specified in the semantic_release.yaml GitHub Action workflow, you must:
    • Create an account on Test PyPI (you only need to do this once).
    • In your Test PyPI account, create an API token under "Account Settings". This will start with pypi-. Copy it.
    • In your GitHub repository, paste the above API token into an action secret named TESTPYPI_API_TOKEN (this secret is used in semantic_release.yaml). This is done in "Settings" -> "Secrets and variables" -> "Actions".
  • Update the name: field in environment.yaml.
  • Update dependencies in environment.yaml and requirements.txt.
  • Update the "Setup" section below.

Setup

Clone the repository:

git clone <UPDATE THIS>

Create a conda environment:

conda env create --file environment.yaml

Activate the conda environment:

conda <UPDATE THIS>

Install the local package in editable mode:

pip install --editable .

References

template's People

Contributors

dluo96 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.