Skip to content

Commit c528eb6

Browse files
committed
Renamed examples and PackageName folders
1 parent ffb24c9 commit c528eb6

File tree

4 files changed

+19
-6
lines changed

4 files changed

+19
-6
lines changed

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,12 @@ dmypy.json
152152
# Cython debug symbols
153153
cython_debug/
154154

155+
### macOS ###
156+
# General
157+
.DS_Store
158+
.AppleDouble
159+
.LSOverride
160+
155161
# PyCharm
156162
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157163
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This repository contains a template for creating your own [Python file reader](h
99
1. Click the "Use this template" button to create your own repository based on this template.
1010
2. Rename `src/FileReaderName` to reflect the name of your modifier.
1111
3. Implement your [file reader](https://ovito.org/docs/dev/python/introduction/custom_file_readers.html) in [`src/FileReaderName/__init__.py`](src/FileReaderName/__init__.py). Fill in the predefined functions as needed. More details on this interface can be found in the [OVITO Python docs](https://ovito.org/docs/dev/python/modules/ovito_io.html#ovito.io.FileReaderInterface).
12-
4. Fill in the [`pyproject.toml`](pyproject.toml) file. Fields that need to be replaced with your information are enclosed in descriptive `[[field]]` tags. Please make sure to include ovito>=3.9 as a dependency. Depending on your needs, you can add additional fields to the `pyproject.toml` file. Information can be found [here](https://setuptools.pypa.io/en/latest/userguide/index.html).
12+
4. Fill in the [`pyproject.toml`](pyproject.toml) file. Fields that need to be replaced with your information are enclosed in descriptive `[[field]]` tags. Please make sure to include ovito>=3.9.1 as a dependency. Depending on your needs, you can add additional fields to the `pyproject.toml` file. Information can be found [here](https://setuptools.pypa.io/en/latest/userguide/index.html).
1313
5. Fill in the [`README_Template.md`](README_Template.md) file. Again, the `[[fields]]` placeholders should guide you. Feel free to add other sections like "Images", "Citation", or "References" as needed.
1414
6. Add meaningful examples and data sample files to the `Examples` directory to help others understand the use of your modifier.
1515
7. Pick a license for your project and replace the current (MIT) [`LICENSE`](LICENSE) file with your license. If you keep the MIT license, please update the name and year in the current file.

pyproject.toml

+12-5
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ requires = ["setuptools", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "[[FileReaderName]]"
6+
name = "[[PackageName]]"
77
version = "[[Version number]]"
88
description = "[[Short description]]"
9-
keywords = ["ovito", "python-file-reader"]
9+
keywords = ["ovito", "ovito-extension"]
1010
authors = [{name = "[[Author 1 name]]", email = "[[Author 1 email]]"}, {name = "[[Author 2 name]]", email = "[[Author 2 email]]"}]
11-
maintainers = [{name = "[[Maintainer 1 name]]", email = "[[Maintainer 1 email]]"}, {name = "[[Maintainer 2 name]]", email = "[[Maintainer 2 email]]"}]
11+
maintainers = [{name = "[[Maintainer 1 name]]", email = "[[Maintainer 1 email]]"}]
1212
license = {text = "[[License]]"}
1313
readme = "README.md"
1414
requires-python = ">=3.7"
@@ -20,7 +20,14 @@ dependencies = [
2020
repository = "[[Repository Link]]"
2121

2222
[project.entry-points.'OVITO.FileReader']
23-
"[[Human readable file reader name]]" = "[[FileReaderName]]:[[FileReaderName]]"
23+
"[[Human readable file reader name]]" = "[[PackageName]]:[[FileReaderName]]"
2424

2525
[tool.setuptools.packages.find]
26-
where = ["src"]
26+
where = ["src"]
27+
28+
[tool.pytest.ini_options]
29+
filterwarnings = [
30+
"error",
31+
"ignore:module 'sre_parse' is deprecated:DeprecationWarning",
32+
"ignore:module 'sre_constants' is deprecated:DeprecationWarning",
33+
]
File renamed without changes.

0 commit comments

Comments
 (0)