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 no rights and add dev docs. #15

Merged
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
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,33 @@ A complex property might look like this:

An agnostic property must always have the `property` property while a complex property may have `property` or
`properties`.

## Development

### Running Tests

Tests can be run with Pytest:

```shell
pytest
```

New versions of packages can be published and pushed to pypi.org with Poetry.

First, make sure you follow [semantic versioning](https://semver.org/) and set a new release version in
`pyproject.toml`:

```toml
[tool.poetry]
name = "utk-exodus"
version = "0.2.1"
```

**Warning**: Failure to follow semantic versioning may break installations and updates with `pip` and `pipx`.

After you set a new `version` in `pyproject.toml`, build an publish your new package like so:

```
poetry build
poetry publish
```
Loading
Loading