bellingcat/auto-archiver
1
0
Fork 0
mirror of https://github.com/bellingcat/auto-archiver.git synced 2026-06-13 13:48:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md for usage with Poetry.

Browse Source
This commit is contained in:
erinhmclark
2025-01-12 20:21:23 +00:00
parent c69a5fa1c9
commit 72a8e76fbb
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -48,7 +48,7 @@ Docker works like a virtual machine running inside your computer, it isolates ev
<details><summary><code>Python package instructions</code></summary> <details><summary><code>Python package instructions</code></summary>
1. make sure you have python 3.10 or higher installed 1. make sure you have python 3.10 or higher installed
2. install the package `pip/pipenv/conda install auto-archiver` 2. install the package with your preferred package manager: `pip/pipenv/conda install auto-archiver` or `poetry add auto-archiver`
3. test it's installed with `auto-archiver --help` 3. test it's installed with `auto-archiver --help`
4. run it with your orchestration file and pass any flags you want in the command line `auto-archiver --config secrets/orchestration.yaml` if your orchestration file is inside a `secrets/`, which we advise 4. run it with your orchestration file and pass any flags you want in the command line `auto-archiver --config secrets/orchestration.yaml` if your orchestration file is inside a `secrets/`, which we advise
@@ -66,12 +66,13 @@ This can also be used for development.
Install the following locally: Install the following locally:
1. [ffmpeg](https://www.ffmpeg.org/) must also be installed locally for this tool to work. 1. [ffmpeg](https://www.ffmpeg.org/) must also be installed locally for this tool to work.
2. [firefox](https://www.mozilla.org/en-US/firefox/new/) and [geckodriver](https://github.com/mozilla/geckodriver/releases) on a path folder like `/usr/local/bin`. 2. [firefox](https://www.mozilla.org/en-US/firefox/new/) and [geckodriver](https://github.com/mozilla/geckodriver/releases) on a path folder like `/usr/local/bin`.
3. (optional) [fonts-noto](https://fonts.google.com/noto) to deal with multiple unicode characters during selenium/geckodriver's screenshots: `sudo apt install fonts-noto -y`. 3. [Poetry](https://python-poetry.org/docs/#installation) for dependency management and packaging.
4. (optional) [fonts-noto](https://fonts.google.com/noto) to deal with multiple unicode characters during selenium/geckodriver's screenshots: `sudo apt install fonts-noto -y`.
Clone and run: Clone and run:
1. `git clone https://github.com/bellingcat/auto-archiver` 1. `git clone https://github.com/bellingcat/auto-archiver`
2. `pipenv install` 2. `poetry install`
3. `pipenv run python -m src.auto_archiver --config secrets/orchestration.yaml` 3. `poetry run python -m src.auto_archiver --config secrets/orchestration.yaml`
</details><br/> </details><br/>
@@ -117,7 +118,7 @@ auto-archiver --config secrets/orchestration.yaml --cli_feeder.urls="url1,url2,u
``` ```
Here's the complete workflow that the auto-archiver goes through: Here's the complete workflow that the auto-archiver goes through:
```mermaid ```{mermaid}
graph TD graph TD
s((start)) --> F(fa:fa-table Feeder) s((start)) --> F(fa:fa-table Feeder)
F -->|get and clean URL| D1{fa:fa-database Database} F -->|get and clean URL| D1{fa:fa-database Database}