Skip to content

Commit

Permalink
Merge pull request #98 from willingc/update-devguide
Browse files Browse the repository at this point in the history
Add some dev setup info about hatch
  • Loading branch information
willingc authored Feb 26, 2024
2 parents b3fae4e + d3955c9 commit 0236052
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions development.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
# Development Guide

## Packaging
Developers can use hatch to simplify set up of a pyosMeta development
environment and executing development tasks.

## Setting up a development environment

### Install hatch

1. Follow the [hatch installation instructions](https://hatch.pypa.io/latest/install/#installation).
2. Open a new terminal and run `hatch --version` to verify that `hatch` is available.

### Open a local dev environment using hatch

In a terminal, enter:

`hatch shell`

You will now have an activated virtual environment.

pyosMeta uses hatch and hatchling as it's build back end.
[To learn more about working with Hatch environments, check out this tutorial.](https://hatch.pypa.io/dev/tutorials/environment/basic-usage/) explains
how hatch uses environments.

To deactivate an environment, enter:

`deactivate`

## Running tests

Expand Down Expand Up @@ -34,3 +55,13 @@ run-coverage = "pytest --cov-config=pyproject.toml --cov=pyosmeta --cov=tests/*"
run-no-cov = "run-coverage --no-cov"
run-report = "run-coverage --cov-report=xml:coverage.xml"
```

## Packaging

pyosMeta uses [hatch](https://hatch.pypa.io) and hatchling as its build back end.

### Build a local package

To create a local sdist and wheel, run:

`hatch build`

0 comments on commit 0236052

Please sign in to comment.