-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
24fbe4e
commit fc30c21
Showing
9 changed files
with
1,061 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Prefect-meemoo Index | ||
|
||
> Auto-generated documentation index. | ||
A full list of `Prefect-meemoo` project modules. | ||
|
||
- [Prefect Meemoo](prefect_meemoo/index.md#prefect-meemoo) | ||
- [Blocks](prefect_meemoo/blocks.md#blocks) | ||
- [Credentials](prefect_meemoo/credentials.md#credentials) | ||
- [Prefect Mediahaven](prefect_meemoo/prefect_mediahaven.md#prefect-mediahaven) | ||
- [Rdf](prefect_meemoo/rdf.md#rdf) | ||
- [Rdf Parse](prefect_meemoo/rdf_parse.md#rdf-parse) | ||
- [Triply](prefect_meemoo/triply.md#triply) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Blocks | ||
|
||
[Prefect-meemoo Index](../README.md#prefect-meemoo-index) / | ||
[Prefect Meemoo](./index.md#prefect-meemoo) / | ||
Blocks | ||
|
||
> Auto-generated documentation for [prefect_meemoo.blocks](../../prefect_meemoo/blocks.py) module. | ||
- [Blocks](#blocks) | ||
- [LastRunConfig](#lastrunconfig) | ||
|
||
## LastRunConfig | ||
|
||
[Show source in blocks.py:8](../../prefect_meemoo/blocks.py#L8) | ||
|
||
Block used to manage the configuration of when a flow last ran (the day). | ||
|
||
#### Attributes | ||
|
||
- `last_run` - The last time the flow ran. | ||
- `flow_name` - The name of the flow. | ||
|
||
#### Examples | ||
|
||
Load stored LastRun configuration: | ||
|
||
```python | ||
from prefect_meemoo.blocks import LastRunConfig | ||
LastRun = LastRunConfig.load("BLOCK_NAME") | ||
last_run = LastRun.last_run | ||
``` | ||
|
||
#### Signature | ||
|
||
```python | ||
class LastRunConfig(Block): | ||
... | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
# Credentials | ||
|
||
[Prefect-meemoo Index](../README.md#prefect-meemoo-index) / | ||
[Prefect Meemoo](./index.md#prefect-meemoo) / | ||
Credentials | ||
|
||
> Auto-generated documentation for [prefect_meemoo.credentials](../../prefect_meemoo/credentials.py) module. | ||
- [Credentials](#credentials) | ||
- [ElasticsearchCredentials](#elasticsearchcredentials) | ||
- [ElasticsearchCredentials().get_client](#elasticsearchcredentials()get_client) | ||
- [MediahavenCredentials](#mediahavencredentials) | ||
- [MediahavenCredentials().get_client](#mediahavencredentials()get_client) | ||
- [PostgresCredentials](#postgrescredentials) | ||
- [TriplyDBCredentials](#triplydbcredentials) | ||
|
||
## ElasticsearchCredentials | ||
|
||
[Show source in credentials.py:62](../../prefect_meemoo/credentials.py#L62) | ||
|
||
Block used to manage authentication with Elasticsearch. | ||
|
||
#### Attributes | ||
|
||
- `password` - Elasticsearch password | ||
- `username` - Elasticsearch username | ||
- `url` - Elasticsearch URL | ||
|
||
#### Examples | ||
|
||
Load stored Elasticsearch credentials: | ||
|
||
```python | ||
from prefect_meemoo.credentials import ElasticsearchCredentials | ||
credentials = ElasticsearchCredentials.load("BLOCK_NAME") | ||
``` | ||
|
||
#### Signature | ||
|
||
```python | ||
class ElasticsearchCredentials(Block): | ||
... | ||
``` | ||
|
||
### ElasticsearchCredentials().get_client | ||
|
||
[Show source in credentials.py:88](../../prefect_meemoo/credentials.py#L88) | ||
|
||
Helper method to get an Elasticsearch client. | ||
|
||
#### Returns | ||
|
||
- An authenticated Elasticsearch client | ||
|
||
#### Signature | ||
|
||
```python | ||
def get_client(self) -> Elasticsearch: | ||
... | ||
``` | ||
|
||
|
||
|
||
## MediahavenCredentials | ||
|
||
[Show source in credentials.py:9](../../prefect_meemoo/credentials.py#L9) | ||
|
||
Block used to manage authentication with Mediahaven. | ||
|
||
#### Attributes | ||
|
||
- `client_secret` - Mediahaven API client secret | ||
- `password` - Mediahaven API password | ||
- `client_id` - Mediahaven API client ID | ||
- `username` - Mediahaven API username | ||
- `url` - Mediahaven API URL | ||
|
||
#### Examples | ||
|
||
Load stored Mediahaven credentials: | ||
|
||
```python | ||
from prefect_meemoo.credentials import MediahavenCredentials | ||
credentials = MediahavenCredentials.load("BLOCK_NAME") | ||
``` | ||
|
||
#### Signature | ||
|
||
```python | ||
class MediahavenCredentials(Block): | ||
... | ||
``` | ||
|
||
### MediahavenCredentials().get_client | ||
|
||
[Show source in credentials.py:41](../../prefect_meemoo/credentials.py#L41) | ||
|
||
Helper method to get a MediaHaven client. | ||
|
||
#### Returns | ||
|
||
- An authenticated MediaHaven client | ||
|
||
#### Raises | ||
|
||
- `-` *ValueError* - if the authentication failed. | ||
- `-` *RequestTokenError* - is the token cannot be requested | ||
|
||
#### Signature | ||
|
||
```python | ||
def get_client(self) -> MediaHaven: | ||
... | ||
``` | ||
|
||
|
||
|
||
## PostgresCredentials | ||
|
||
[Show source in credentials.py:105](../../prefect_meemoo/credentials.py#L105) | ||
|
||
Block used to manage authentication with Postgres. | ||
|
||
#### Attributes | ||
|
||
- `password` - Postgres password | ||
- `username` - Postgres username | ||
- `host` - Postgres host | ||
- `port` - Postgres port | ||
|
||
#### Examples | ||
|
||
Load stored Postgres credentials: | ||
|
||
```python | ||
from prefect_meemoo.credentials import PostgresCredentials | ||
credentials = PostgresCredentials.load("BLOCK_NAME") | ||
``` | ||
|
||
#### Signature | ||
|
||
```python | ||
class PostgresCredentials(Block): | ||
... | ||
``` | ||
|
||
|
||
|
||
## TriplyDBCredentials | ||
|
||
[Show source in credentials.py:135](../../prefect_meemoo/credentials.py#L135) | ||
|
||
Block used to manage authentication with TriplyDB. | ||
|
||
#### Attributes | ||
|
||
- `token` - The JWT token of the user | ||
- `owner` - The user or organization that owns the dataset | ||
- `dataset` - "Name of the default dataset. | ||
- `graph` - Name of the default Named Graph in the dataset. | ||
- `host` - TriplyDB HTTP host address | ||
|
||
#### Examples | ||
|
||
Load stored TriplyDB credentials: | ||
|
||
```python | ||
from prefect_meemoo.credentials import TriplyDBCredentials | ||
credentials = TriplyDBCredentials.load("BLOCK_NAME") | ||
``` | ||
|
||
#### Signature | ||
|
||
```python | ||
class TriplyDBCredentials(Block): | ||
... | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Prefect Meemoo | ||
|
||
[Prefect-meemoo Index](../README.md#prefect-meemoo-index) / | ||
Prefect Meemoo | ||
|
||
> Auto-generated documentation for [prefect_meemoo](../../prefect_meemoo/__init__.py) module. | ||
- [Prefect Meemoo](#prefect-meemoo) | ||
- [Modules](#modules) | ||
|
||
## Modules | ||
|
||
- [Blocks](./blocks.md) | ||
- [Credentials](./credentials.md) | ||
- [Prefect Mediahaven](./prefect_mediahaven.md) | ||
- [Rdf](./rdf.md) | ||
- [Rdf Parse](./rdf_parse.md) | ||
- [Triply](./triply.md) |
Oops, something went wrong.