An open API service indexing awesome lists of open source software.

https://github.com/willf/scrape-fws-servcat


https://github.com/willf/scrape-fws-servcat

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

# scrape-fws-servcat

[![Build status](https://img.shields.io/github/actions/workflow/status/willf/scrape-fws-servcat/main.yml?branch=main)](https://github.com/willf/scrape-fws-servcat/actions/workflows/main.yml?query=branch%3Amain)
[![License](https://img.shields.io/github/license/willf/scrape-fws-servcat)](https://img.shields.io/github/license/willf/scrape-fws-servcat)

Access US Fish and Wildlife Serices ServCat

- **Github repository**:
- **Documentation**

## Getting started with your project

### 1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:willf/scrape-fws-servcat.git
git push -u origin main
```

### 2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### 3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### 4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

---

Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).