Skip to content

xonsh/xontrib-template

main
Switch branches/tags
Code

A template for creating the xonsh contributions called xontribs.

If you like the template click on the repo.

asciicast

Why use this template?

This template includes good pack of prebuilt files:

  • README with the info and xontrib promotion instructions
  • PEP 621 or poetry based pyproject.toml file to make and install PyPi package easily
  • .gitattributes file to enable Github syntax highlighting for *.xsh files
  • .gitignore file with standard list of directories to ignore
  • .github/workflow/push-test.yml to automatically test the code using Github Actions
  • .github/*_template.md files to create Github templates for the text of issue and PR.
  • MANIFEST.in file to make Conda feedstock easily
  • LICENSE file with standard MIT license
  • tests/ with the test suite

Create new xontrib

This template uses copier. We can install it as a CLI using pipx:

pipx install copier
pipx inject copier jinja2-time
pipx inject copier cookiecutter

Now to create your new xontrib:

copier gh:xonsh/xontrib-template .

Advent of PEP-621

Older projects can use the following tools to upgrade their setup to use pyproject.toml

Development

  • copier selects the latest tag when --vcs-ref option is not given. So it is important to tag the main branch after important template updates.

Links

About

A cookiecutter template for xontribs, a.k.a xonsh contributions

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages