Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(semantic-release): downgrade conventional-changelog-conventionalcommits due to release error #31

Merged
merged 2 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

name: Release
on:
workflow_dispatch:
Expand Down Expand Up @@ -51,7 +50,7 @@ jobs:
run: |
npx --yes \
-p semantic-release \
-p conventional-changelog-conventionalcommits \
-p "conventional-changelog-conventionalcommits@7.0.2" \
-p "@semantic-release/commit-analyzer" \
-p "@semantic-release/release-notes-generator" \
-p "@semantic-release/changelog" \
Expand All @@ -68,7 +67,7 @@ jobs:
run: |
npx --yes \
-p semantic-release \
-p conventional-changelog-conventionalcommits \
-p "conventional-changelog-conventionalcommits@7.0.2" \
-p "@semantic-release/commit-analyzer" \
-p "@semantic-release/release-notes-generator" \
-p "@semantic-release/changelog" \
Expand Down
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,23 @@ Before running Episcanner Downloader, make sure to set the required environment
## Usage
To use Episcanner Downloader, follow these steps:

1. Execute the binary (examples for Linux):
```shell
cd dist/
./episcanner -h
./episcanner -y 2023 -s RJ -d dengue -o /tmp -f duckdb
./episcanner -y 2021 2022 2023 --all -d zika -f csv parquet --verbose
```
*Replace <source> with the desired source (e.g., 'MG', or '--all' to download all states) and <diseases> with the specific diseases you want to download (e.g., 'dengue chikungunya'). Specify the <output_directory> where the data should be saved.*
1. Open the python console or another python interpreter:
```python
from scanner import Episcanner
scanner = EpiScanner(disease="dengue", uf="RJ", year=2024)
scanner.export("duckdb")
```

*Replace `uf` with the desired state (e.g., 'MG') and `disease` with the specific disease you want to download ('dengue', 'chikungunya' or 'zika'). Specify the `output_dir` on the `export()` method to change where the data should be saved.*

2. In order to read the data, open the file using `duckdb`:
```python
import duckdb
db = duckdb.connect("<$HOME>/episcanner/episcanner.duckdb")
db.execute("SELECT * FROM 'RJ' WHERE disease = 'dengue' AND year = 2024").fetchdf()
```

Replace <$HOME> with your actual home directory or use the `output_dir` specified in the export method

## License
Episcanner Downloader is licensed under the [MIT License](https://github.com/AlertaDengue/episcanner-downloader/blob/main/LICENSE). See the LICENSE file for more details.
Loading