Skip to content

Commit

Permalink
a couple more little changes
Browse files Browse the repository at this point in the history
  • Loading branch information
travishathaway committed Nov 1, 2023
1 parent a8cabc8 commit 7190f7b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:

- name: Install dependencies
run: |
pixi add python=${{ matrix.python-version }}
pixi add python=${{ matrix.python-version }} &&
pixi install
- name: Run test and generate coverage
Expand Down
File renamed without changes.
30 changes: 21 additions & 9 deletions docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,42 @@ and is at the latest version.

### Creating the development environment

#### Prerequisites

This project is managed with the [pixi](https://pixi.sh). Please [install pixi](https://prefix.dev/docs/pixi/overview#installation)
first before continuing.

To set up your development environment, follow these steps:

1. Create a fork of the repository in GitHub (sign up a for a GitHub account if your don't already have one)
2. Clone the forked repository to your local computer
3. Set up and activate the development environment with these commands:
```
conda env create --file environment.yml
conda install --file requirements.dev.txt
conda activate conda-auth
pip install -e .
pixi install
pixi run develop
```
4. Next, you will want to start new shell with the following command:
```
pixi shell
```
4. To verify the installation, run the `conda` command with no arguments and make sure `auth` shows up under
5. To verify the installation, run the `conda` command with no arguments and make sure `auth` shows up under
the list of available commands.

Once this has been done, you should be ready to start make changes to the conda-auth library and
Once this has been done, you should be ready to start make changes to the conda-auth plugin and
experimenting with it on your computer.

### Running tests

This project uses `pytest`. To run the test for conda-auth, run the following command from an activated
development environment:
To run the test for conda-auth, run the following command:

```
pixi run test
```

Or, to generate an HTML coverage report, run with the following command:

```
pytest tests
pixi run testhtml
```

## Submitting a pull request
Expand Down
2 changes: 1 addition & 1 deletion pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ pre-commit = "*"
rattler-build = "*"

[activation]
scripts = ["setup.sh"]
scripts = ["dev/setup.sh"]

0 comments on commit 7190f7b

Please sign in to comment.