Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ __pycache__/
# Distribution / packaging
.Python
env/
.venv
build/
develop-eggs/
dist/
Expand Down
35 changes: 35 additions & 0 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[![CI]({{repo_url}}/actions/workflows/ci.yml/badge.svg)]({{repo_url}}/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/{{github_org}}/{{repo_name}}/branch/master/graph/badge.svg)](https://codecov.io/gh/{{github_org}}/{{repo_name}})
[![PyPI](https://img.shields.io/pypi/v/{{pypi_name}}.svg)](https://pypi.org/project/{{pypi_name}})
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# {{ package_name }}

This is where you should write a short paragraph that describes what your module does,
how it does it, and why people should use it.

Source | <{{repo_url}}>
:---: | :---:
PyPI | `pip install {{pypi_name}}`
Documentation | <{{docs_url}}>
Releases | <{{repo_url}}/releases>

This is where you should put some images or code snippets that illustrate
some relevant examples. If it is a library then you might put some
introductory code here:

```python
from {{package_name}} import __version__

print(f"Hello {{package_name}} {__version__}")
```

Or if it is a commandline tool then you might put some example commands here:

```
python -m {{package_name}} --version
```

<!-- README only content. Anything below this line won't be included in index.md -->

See {{docs_url}} for more detailed documentation.
56 changes: 0 additions & 56 deletions template/README.rst.jinja

This file was deleted.

5 changes: 3 additions & 2 deletions template/pyproject.toml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ requires-python = ">=3.7"
[project.optional-dependencies]
dev = [
"black",
"pyright",
"copier",
"myst-parser",
"pipdeptree",
"pre-commit",
"pydata-sphinx-theme>=0.12",
"pyright",
"pytest",
"pytest-cov",
"ruff",
Expand All @@ -37,7 +39,6 @@ dev = [
"sphinx-design",
"tox-direct",
"types-mock",
"copier",
]

[project.scripts]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contribute to the project

Contributions and issues are most welcome! All issues and pull requests are
handled through [GitHub]({{ repo_url }}/issues). Also, please check for any existing issues before
filing a new one. If you have a great idea but it involves big changes, please
file a ticket before making a pull request! We want to make sure you don't spend
your time coding something that might not fit the scope of the project.

## Issue or Discussion?

Github also offers [discussions]({{ repo_url }}/discussions) as a place to ask questions and share ideas. If
your issue is open ended and it is not obvious when it can be "closed", please
raise it as a discussion instead.

## Code Coverage

While 100% code coverage does not make a library bug-free, it significantly
reduces the number of easily caught bugs! Please make sure coverage remains the
same or is improved by a pull request!

## Developer Information

It is recommended that developers use a [vscode devcontainer](https://code.visualstudio.com/docs/devcontainers/containers). This repository contains configuration to set up a containerized development environment that suits its own needs.

This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
The template's [Developer Guide](https://diamondlightsource.github.io/python-copier-template) contains detailed information on setting up a development environment, running the tests and what standards the code and documentation
should follow.

This file was deleted.

8 changes: 5 additions & 3 deletions template/{% if sphinx %}docs{% endif %}/conf.py.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,13 @@ extensions = [
"sphinx_copybutton",
# For the card element
"sphinx_design",
# So we can write markdown files
"myst_parser",
]

# So we can use the ::: syntax
myst_enable_extensions = ["colon_fence"]

# If true, Sphinx will warn about all references where the target cannot
# be found.
nitpicky = True
Expand Down Expand Up @@ -82,9 +87,6 @@ graphviz_output_format = "svg"
# role, that is, for text marked up `like this`
default_role = "any"

# The suffix of source filenames.
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

39 changes: 0 additions & 39 deletions template/{% if sphinx %}docs{% endif %}/developer/how-to/lint.rst

This file was deleted.

This file was deleted.

Loading