Skip to content

Commit 97b1053

Browse files
znichollscrznichollscr
committed
Add other needed files
1 parent 352329b commit 97b1053

5 files changed

Lines changed: 295 additions & 0 deletions

File tree

‎.copier-answers.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2+
_commit: v0.10.1
3+
_src_path: gl:znicholls/copier-core-python-repository
4+
conda_release: false
5+
email: zebedee.nicholls@climate-resource.com
6+
include_cli: false
7+
name: Zebedee Nicholls
8+
notebook_based_docs: false
9+
package_manager: uv
10+
pandas_doctests: false
11+
plot_dependencies: false
12+
project_description_short: Support for documenting accessors with mkdocstrings.
13+
project_name_human: mkdocstrings-python-accessors
14+
project_name_pip: mkdocstrings-python-accessors
15+
project_name_python: mkdocstrings_python_accessors
16+
project_url: https://github.com/climate-resource/mkdocstrings-python-accessors
17+
track_lock_file: false

‎.gitignore‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Notebooks
2+
*.ipynb
3+
4+
# Lock file
5+
pdm.lock
6+
# Associated requirements file
7+
requirements.txt
8+
9+
# Auto-generated docs and helper files
10+
docs/api/*
11+
!docs/api/.gitkeep
12+
13+
# pdm stuff
14+
.pdm-python
15+
16+
# Databases
17+
*.db
18+
19+
# Jupyter cache
20+
.jupyter_cache
21+
22+
# IDE stuff
23+
.idea/
24+
25+
# Ruff cache
26+
.ruff_cache
27+
28+
# Licence check
29+
licence-check.txt
30+
31+
# Byte-compiled / optimized / DLL files
32+
__pycache__/
33+
*.py[cod]
34+
*$py.class
35+
36+
# C extensions
37+
*.so
38+
39+
# Distribution / packaging
40+
.Python
41+
build/
42+
develop-eggs/
43+
dist/
44+
downloads/
45+
eggs/
46+
.eggs/
47+
lib/
48+
lib64/
49+
parts/
50+
sdist/
51+
var/
52+
wheels/
53+
pip-wheel-metadata/
54+
share/python-wheels/
55+
*.egg-info/
56+
.installed.cfg
57+
*.egg
58+
MANIFEST
59+
60+
# PyInstaller
61+
# Usually these files are written by a python script from a template
62+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
63+
*.manifest
64+
*.spec
65+
66+
# Installer logs
67+
pip-log.txt
68+
pip-delete-this-directory.txt
69+
70+
# Unit test / coverage reports
71+
htmlcov/
72+
.tox/
73+
.nox/
74+
.coverage
75+
.coverage.*
76+
.cache
77+
nosetests.xml
78+
coverage.xml
79+
*.cover
80+
*.py,cover
81+
.hypothesis/
82+
.pytest_cache/
83+
84+
# Translations
85+
*.mo
86+
*.pot
87+
88+
# Django stuff:
89+
*.log
90+
local_settings.py
91+
db.sqlite3
92+
db.sqlite3-journal
93+
94+
# Flask stuff:
95+
instance/
96+
.webassets-cache
97+
98+
# Scrapy stuff:
99+
.scrapy
100+
101+
# Sphinx documentation
102+
docs/_build/
103+
104+
# PyBuilder
105+
target/
106+
107+
# Jupyter Notebook
108+
.ipynb_checkpoints
109+
110+
# IPython
111+
profile_default/
112+
ipython_config.py
113+
114+
# pyenv
115+
.python-version
116+
117+
# pipenv
118+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
119+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
120+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
121+
# install all needed dependencies.
122+
#Pipfile.lock
123+
124+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
125+
__pypackages__/
126+
127+
# Celery stuff
128+
celerybeat-schedule
129+
celerybeat.pid
130+
131+
# SageMath parsed files
132+
*.sage.py
133+
134+
# Environments
135+
.env
136+
.venv
137+
env/
138+
venv/
139+
ENV/
140+
env.bak/
141+
venv.bak/
142+
143+
# Spyder project settings
144+
.spyderproject
145+
.spyproject
146+
147+
# Rope project settings
148+
.ropeproject
149+
150+
# mkdocs documentation
151+
/site
152+
153+
# mypy
154+
.mypy_cache/
155+
.dmypy.json
156+
dmypy.json
157+
158+
# Pyre type checker
159+
.pyre/
160+
161+
# Mac stuff
162+
*.DS_Store

‎.pre-commit-config.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# See https://pre-commit.com for more information
2+
ci:
3+
autofix_prs: false
4+
autoupdate_schedule: quarterly
5+
autoupdate_branch: pre-commit-autoupdate
6+
# Currently network access isn't supported in the pre-commit CI product.
7+
skip: [uv-lock, uv-export, pdm-lock-check]
8+
9+
# See https://pre-commit.com/hooks.html for more hooks
10+
repos:
11+
- repo: https://github.com/pre-commit/pre-commit-hooks
12+
rev: "v5.0.0"
13+
hooks:
14+
- id: check-added-large-files
15+
- id: check-ast
16+
- id: check-case-conflict
17+
- id: check-json
18+
- id: check-merge-conflict
19+
- id: check-symlinks
20+
- id: check-yaml
21+
- id: debug-statements
22+
- id: detect-private-key
23+
- id: end-of-file-fixer
24+
- id: fix-byte-order-marker
25+
- id: mixed-line-ending
26+
- id: trailing-whitespace
27+
- repo: local
28+
hooks:
29+
# Prevent committing .rej files
30+
- id: forbidden-files
31+
name: forbidden files
32+
entry: found Copier update rejection files; review them and remove them
33+
language: fail
34+
files: "\\.rej$"
35+
- repo: https://github.com/charliermarsh/ruff-pre-commit
36+
rev: "v0.8.4"
37+
hooks:
38+
- id: ruff
39+
args: [ --fix, --exit-non-zero-on-fix ]
40+
- id: ruff-format

‎LICENCE‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2024, mkdocstrings-python-accessors contributors
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎changelog/README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# CHANGELOG
2+
3+
This directory contains "news fragments",
4+
i.e. short files that contain a small markdown-formatted bit of text
5+
that will be added to the CHANGELOG when it is next compiled.
6+
7+
The CHANGELOG will be read by users,
8+
so this description should be aimed to mkdocstrings-python-accessors users
9+
instead of describing internal changes which are only relevant to developers.
10+
Merge requests in combination with our git history
11+
provide additional developer-centric information.
12+
13+
Make sure to use phrases in the past tense and use punctuation, examples:
14+
15+
```
16+
Improved verbose diff output with sequences.
17+
18+
Terminal summary statistics now use multiple colors.
19+
```
20+
21+
Each file should have a name of the form `<MR>.<TYPE>.md`, where `<MR>` is the merge request number, and `<TYPE>` is one of:
22+
23+
* `feature`: new user facing features, like new command-line options and new behaviour.
24+
* `improvement`: improvement of existing functionality, usually without requiring user intervention
25+
* `fix`: fixes a bug.
26+
* `docs`: documentation improvement, like rewording an entire section or adding missing docs.
27+
* `deprecation`: feature deprecation.
28+
* `breaking`: a change which may break existing uses, such as feature removal or behaviour change.
29+
* `trivial`: fixing a small typo or internal change that might be noteworthy.
30+
31+
So for example: `123.feature.md`, `456.fix.md`.
32+
33+
Since you need the merge request number for the filename, you must submit a MR first.
34+
From this MR, you can get the MR number and then create the news file.
35+
A single MR can also have multiple news items,
36+
for example a given MR may add a feature as well as deprecate some existing functionality.
37+
38+
If you are not sure what issue type to use, don't hesitate to ask in your MR.
39+
40+
`towncrier` preserves multiple paragraphs and formatting
41+
(code blocks, lists, and so on),
42+
but for entries other than features it is usually better to stick to a single paragraph to keep it concise.
43+
You may also use [mkdocs-autorefs cross-referencing](https://mkdocstrings.github.io/autorefs/)
44+
within your news items to link to other documentation.
45+
46+
You can also run `towncrier build --draft --version draft`
47+
to see the draft changelog that will be appended to the CHANGELOG on the next release.

0 commit comments

Comments
 (0)