Skip to content

Commit

Permalink
Switch to theme
Browse files Browse the repository at this point in the history
  • Loading branch information
palewire authored Dec 29, 2023
1 parent a7a7a86 commit b7561c8
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 368 deletions.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sphinx = "*"
setuptools-scm = "*"
pre-commit = "*"
myst-parser = "*"
sphinx-palewire-theme = "*"

[packages]
click = "*"
Expand Down
9 changes: 8 additions & 1 deletion Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

57 changes: 1 addition & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,4 @@
# Califire Wildfires
Download wildfires data from Calfire

## Installation
```
pipenv install calfire-wildfires
```
## Command-line usage

```
Usage: calfirewildfires [OPTIONS] COMMAND [ARGS]...
A command-line interface for downloading wildfires data from CalFire.
Returns GeoJSON.
Options:
--help Show this message and exit.
Commands:
active-fires The latest active fires
all-fires Fires year-to-date, both active and contained
```

From the shell:
```
calfirewildfires all-fires
calfirewildfires active-fires
```

## Python usage
Import the library.
```
import calfire_wildfires
data = calfire_wildfires.get_all_fires()
data = calfire_wildfires.get_active_fires()
```

## Contributing
Install dependencies for development.
```
pipenv install --dev
```

Run tests.
```
pipenv run python test.py
```

## Developing the CLI
The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as prescribed by the Click documentation.
```
pipenv run pip install --editable .
```

### Links
### Other resources

* Docs: [palewi.re/docs/calfire-wildfires/](https://palewi.re/docs/calfire-wildfires/)
* Issues: [github.com/datadesk/calfire-wildfires/issues](https://github.com/datadesk/calfire-wildfires/issues)
Expand Down
234 changes: 0 additions & 234 deletions docs/_static/css/custom.css

This file was deleted.

49 changes: 0 additions & 49 deletions docs/_templates/nav.html

This file was deleted.

Loading

0 comments on commit b7561c8

Please sign in to comment.