Skip to content

Commit

Permalink
docs: suggested changes from review notes
Browse files Browse the repository at this point in the history
Co-authored-by: jaimergp <[email protected]>
  • Loading branch information
2 people authored and hulkoba committed Aug 23, 2024
1 parent 9980473 commit cb947e3
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,12 @@ When everything is configured you can trigger a build with a push to the feedsto
Developing `conda-smithy`
-----------------------

If you don’t already have a conda-based environment manager, install one. For example [Miniconda]((https://docs.anaconda.com/free/miniconda/miniconda-install/)).
If you don’t already have a conda-based environment manager, install one. For example [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/).

To develop `conda-smithy`, use said environment manager and create an environment based on the `environment.yml`.
To develop `conda-smithy`, use said environment manager and create an environment based on the included `environment.yml` file.

```sh
$ conda env create
$ conda env create -f environment.yml
```

Then activate the environment, check that it works and install the dependencies:
Expand All @@ -125,14 +125,14 @@ Then activate the environment, check that it works and install the dependencies:
$ conda activate conda-smithy
$ which python
# ☝️ should now point to an environment-specific python
$ python -m pip install .
$ python -m pip install -e . --no-deps
```

You might want to switch Python versions, for example if you wish to exactly replicate a CI issue locally. To do that:

- Change the Python version in the `environment.yml`
- Deactivate and delete old environment, if you have it: `conda deactivate && conda env delete -n conda-smithy`
- (re-)run `conda env create` and activate the new environment with `conda activate conda-smithy`
```sh
conda install -n conda-smithy python=x.y
```

### Testing

Expand All @@ -145,7 +145,7 @@ pytest tests/test_configure_feedstock.py

Run specific test within a file:
```sh
pytest tests/test_configure_feedstock.py -k test_cuda_enabled_render
pytest tests/test_configure_feedstock.py::test_cuda_enabled_render
```

Run with coverage (this is how the tests are run in CI):
Expand All @@ -162,12 +162,6 @@ If test coverage is reported as 0%, your `pytest` and `pytest-cov` plugin might
python -m pytest tests --cov conda_smithy --cov-report lcov --cov-report term-missing
```

You may find that your latest changes aren’t reflected in a test run, in such cases, you can try rebuilding the project:

```sh
python -m pip install -v --no-build-isolation -e . && pytest tests
```

### Linting and Formatting

This repo currently uses `flake8` for linting (but doesn’t enforce it) and `black` for auto-formatting. `black` is already configured in the pre-commit hook, but you can run it manually whenever you like with:
Expand All @@ -178,8 +172,6 @@ pre-commit run --all-files

To run flake, just type `flake8`. Note that `black` doesn’t auto-fix all errors found by `flake8`.

**Note:** There is [an ongoing effort](https://github.com/conda-forge/conda-smithy/pull/1919) to replace `flake8` with `ruff`, which will then also be able to format away many of the issues it finds.

Releasing conda-smithy
----------------------

Expand Down

0 comments on commit cb947e3

Please sign in to comment.