Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update the general files to align with PyAnsys standards #3151

Merged
merged 7 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
8 changes: 8 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# they will be requested for review when someone opens a pull request.

* @ansys/pymapdl-maintainers
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ repos:
rev: v2.3.0
hooks:
- id: codespell
args: ["--toml", "pyproject.toml", "--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]
args: ["--toml", "pyproject.toml", "--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt", "-w"]
additional_dependencies: ["tomli"]

# - repo: https://github.com/pycqa/pydocstyle
Expand Down
12 changes: 12 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This is the list of PyMAPDL's significant contributors.
#
# This file does not necessarily list everyone who has contributed code.
#
# For contributions made under a Corporate CLA, the organization is
# added to this file.
#
# If you have contributed to the repository and want to be added to this file,
# submit a request.
#
#
ANSYS, Inc.
7 changes: 0 additions & 7 deletions CODEOWNERS

This file was deleted.

4 changes: 2 additions & 2 deletions AUTHORS.md → CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Authors
# Contributors

## Project Lead

* [German Martinez Ayuso](https://github.com/germa89)

## Contributors
## Individual Contributors

* [Alex Kaszynski](https://github.com/akaszynski)
* [Camille Latapie](https://github.com/clatapie)
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,15 @@ the most recent citation.

## License and acknowledgments

[PyMAPDL](https://mapdl.docs.pyansys.com/version/stable/) is licensed under
[PyMAPDL](https://mapdl.docs.pyansys.com/) is licensed under
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
[the MIT license](https://github.com/ansys/pymapdl/blob/main/LICENSE).

[ansys-mapdl-core](https://pypi.org/project/ansys-mapdl-core/) package
makes no commercial claim over Ansys whatsoever.
This tool extends the functionality of ``MAPDL`` by adding a Python
interface to the MAPDL service without changing the
core behavior or license of the original software. The use of the
interactive APDL control of [PyMAPDL](https://mapdl.docs.pyansys.com/version/stable/)
interactive APDL control of [PyMAPDL](https://mapdl.docs.pyansys.com/)
requires a legally licensed local copy of Ansys.

To get a copy of Ansys, visit [Ansys](https://www.ansys.com/).
12 changes: 4 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,8 @@ description = "A Python wrapper for Ansys MAPDL."
readme = "README.md"
requires-python = ">=3.9,<3.13" # Update also 'MINIMUM_PYTHON_VERSION' in src/ansys/mapdl/core/__init__.py
license = {file = "LICENSE"}
authors = [
{name = "Ansys, Inc.", email = "[email protected]"},
]
maintainers = [
{name = "PyAnsys developers", email = "[email protected]"},
]
authors = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
maintainers = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
dependencies = [
"ansys-api-mapdl==0.5.1", # supports at least 2020R2 - 2022R1
"ansys-mapdl-reader>=0.51.7",
Expand Down Expand Up @@ -113,6 +109,8 @@ name = "ansys.mapdl.core"

[project.urls]
Source = "https://github.com/ansys/pymapdl"
Issues = "https://github.com/ansys/pymapdl/issues"
Documentation = "https://mapdl.docs.pyansys.com"
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved

[project.scripts]
pymapdl_convert_script = "ansys.mapdl.core.cli:old_pymapdl_convert_script_entry_point"
Expand Down Expand Up @@ -143,7 +141,6 @@ default_section = "THIRDPARTY"
skip_glob = ["__init__.py"]
src_paths = ["doc", "src", "tests"]


[tool.coverage.run]
source = ["ansys/pymapdl"]
omit = [
Expand All @@ -159,7 +156,6 @@ show_missing = true

[tool.codespell]
skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./docker/mapdl/v*,./factory/*,./ansys/mapdl/core/mapdl_functions.py,PKG-INFO,*.mypy_cache/*,./docker/mapdl/*,./_unused/*'
ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
quiet-level = 3
ignore-regex=".*codespell-ignore$|NORML|POIN"

Expand Down