|
| 1 | +--- |
| 2 | +title: An opinionated template for Data Packages built with Seedcase packages |
| 3 | +--- |
| 4 | + |
| 5 | +{{< include /docs/includes/_badges.qmd >}} |
| 6 | + |
| 7 | +This is a template for creating a new [Data |
| 8 | +Package](https://decisions.seedcase-project.org/why-frictionless-data/) |
| 9 | +following the Seedcase structure. Use this template to quickly get |
| 10 | +started with a new Data Package with all the necessary files and |
| 11 | +configurations in place, including for developing the Data Package. |
| 12 | + |
| 13 | +## Features |
| 14 | + |
| 15 | +::: content-hidden |
| 16 | +<!-- TODO: Move this down once a license has been decided on. --> |
| 17 | + |
| 18 | +- Licensed under the open data license TODO. This is added by default, |
| 19 | + but you can delete or modify it if it isn't what you want or can |
| 20 | + use. |
| 21 | +::: |
| 22 | + |
| 23 | +- Use [uv](https://decisions.seedcase-project.org/why-uv/) to manage |
| 24 | + the Data Package. |
| 25 | +- Use [Polars](https://www.pola.rs/) for data manipulation. |
| 26 | +- Use [Seedcase Sprout](https://sprout.seedcase-project.org/) to |
| 27 | + create and modify the Data Package. |
| 28 | +- Build management with [justfile](https://just.systems/man/en/). |
| 29 | +- Check typos with [typos](https://github.com/crate-ci/typos). |
| 30 | +- Code formatting and linting with |
| 31 | + [ruff](https://decisions.seedcase-project.org/why-ruff/). |
| 32 | +- Pre-commit hooks with [pre-commit](https://pre-commit.com/). |
| 33 | +- GitHub workflows for automatically adding Pull Requests and Issues |
| 34 | + to a project board. |
| 35 | +- Pull Request template for easy creation of new Pull Requests. |
| 36 | +- [VS Code](https://code.visualstudio.com/) settings commonly |
| 37 | + used by contributors working in VS Code. |
| 38 | +- [EditorConfig](https://editorconfig.org/) for common cross-editor |
| 39 | + settings for contributors. |
| 40 | +- [`CITATION.cff`](https://citation-file-format.github.io/) file for |
| 41 | + citation information. |
| 42 | +- Website generation with [Quarto](https://quarto.org/). |
| 43 | +- Folder and file structure that mimics a Python package to take |
| 44 | + advantage of Python's packaging ecosystem. |
| 45 | +- [`pyproject.toml`](https://peps.python.org/pep-0518/) for tracking |
| 46 | + dependencies and project metadata. |
| 47 | + |
| 48 | +## Want to contribute? |
| 49 | + |
| 50 | +We would love your feedback or contributions! Head over to our [GitHub |
| 51 | +repository](https://github.com/seedcase-project/{{< meta repo >}}) to |
| 52 | +share your ideas or contribute code. Your input makes us better! |
0 commit comments