Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ further defined and clarified by project maintainers.

This code of conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>
70 changes: 3 additions & 67 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,74 +3,10 @@
Overall guidance on contributing to a PyAnsys library appears in the
[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
are thoroughly familiar with this guide before attempting to contribute to
ansys-tools.
{project-name}.

The following contribution information is specific to *Ansys Tools*.
The following contribution information is specific to {project-name}.

[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html

## Clone the repository

To clone and install the latest *Ansys Tools* release in development mode, run
these commands:

```bash
git clone https://github.com/ansys/ansys-tools-common/
cd ansys-tools
python -m pip install --upgrade pip
pip install -e .
```

## Adhere to code style

*Ansys Tools* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.

To ensure your code meets minimum code styling standards, run these commands:

```bash
pip install pre-commit
pre-commit run --all-files
```

You can also install this as a pre-commit hook by running this command:

```bash
pre-commit install
```

## Run the tests

Prior to running the tests, you must run this command to install the test dependencies:

```bash
pip install -e .[tests]
```

To run the tests, navigate to the root directory of the repository and run this command:

```bash
pytest
```


## Build the documentation

Prior to building the documentation, you must run this command to install the documentation dependencies:

```bash
pip install -e .[doc]
```

To build the documentation, run the following commands:

```bash
cd doc

# On linux
make html

# On windows
./make.bat html
```

The documentation is built in the `docs/_build/html` directory.
<!-- Begin content specific to your library here. -->
14 changes: 7 additions & 7 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ MIT License

Copyright (c) 2025 ANSYS, Inc. and/or its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
1 change: 1 addition & 0 deletions doc/source/changelog/122.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Chore: Update missing or outdated files