mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 04:55:44 +00:00
docs: update README.md with script boilerplate
This commit is contained in:
17
README.md
17
README.md
@@ -73,6 +73,23 @@ import tembo.cli
|
||||
tembo.cli.CONFIG
|
||||
```
|
||||
|
||||
### Script
|
||||
|
||||
Create `./config/config.yml` in the same directory as the script.
|
||||
|
||||
In the script initialise a `CONFIG` object:
|
||||
|
||||
```python
|
||||
import pathlib
|
||||
|
||||
import panaetius
|
||||
|
||||
CONFIG = panaetius.Config(
|
||||
"teenagers_scraper", str(pathlib.Path(__file__).parents[0] / ".config"), skip_header_init=True
|
||||
)
|
||||
```
|
||||
|
||||
Set variables in the same way as the module above.
|
||||
|
||||
## Utility Functions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user