Using Github API (to pull individuals, orgs, and article content), setup a local sqlite database, syncing images to Cloudflare.
Project description
corpus-pax
Initial, foundational sqlite tables with generic users, organizations, and articles.
flowchart TB
subgraph dev env
pax[corpus-pax]
pax--run setup--->db[(sqlite.db)]
end
subgraph /corpus-entities
1(members)--github api---pax
2(orgs)--github api---pax
end
subgraph /lawsql-articles
3(articles)--github api---pax
end
pax--cloudflare api-->cf(cloudflare images)
Prerequisites
Repository | Description |
---|---|
corpus-entities | yaml-formatted member and org files |
lawsql-articles | markdown-styled articles with frontmatter |
Since data concerning members will be pulled from such repositories, make sure the individual / org fields in resources.py match the data pulled from corpus-entities
.
Each avatar image should be named avatar.jpeg
so that these can be uploaded to Cloudflare.
Install
poetry add corpus-pax
poetry update
Supply .env
Create an .env file to create/populate the database. See sample .env highlighting the following variables:
- Cloudflare
CF_ACCT
- Cloudflare
CF_TOKEN
- Github
GH_TOKEN
DB_FILE
(sqlite)
Note the workflow where the secrets are included for Github actions. Ensure these are set in the repository's <url-to-repo>/settings/secrets/actions
, making the proper replacements when the tokens for Cloudflare and Github expire.
Notes
Why Github
The names and profiles of individuals and organizations are stored in Github. These are pulled into the application via an API call requiring the use of a personal access token.
Why Cloudflare Images
Individuals and organizations have images stored in Github. To persist and optimize images for the web, I use Cloudflare Images to take advantage of modern image formats and customizable variants.
Why sqlite
The initial data is simple. This database however will be the foundation for a more complicated schema. Sqlite seems a better fit for experimentation and future app use (Android and iOS rely on sqlite).
Steps
Need to specify filename, e.g. ex.db, for this to created in the root directory of the project folder.
Without the filename, the Connection
(sqlite-utils' Database() under the hood) used is the path declared in $env.DB_FILE
from sqlpyd import Connection # this is sqlite-utils' Database() under the hood
from corpus_pax import setup
c = Connection(DatabasePath="ex.db", WALMode=False)
setup_pax_db("x.db")
Gotcha
The m2m tables are not corrected when an update is made via add_individuals_from_api()
, add_organizations_from_api()
and add_articles_from_api()
. To alleviate, simply reset the tables and recreate the same from scratch.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for corpus_pax-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1a4b99d1fe404fcb27dc0d6e1060f5405f156d5f892666bf0aab69b4863ac1e |
|
MD5 | f6fdd8d1433382d78c259a3ac111e5a3 |
|
BLAKE2b-256 | 72e53c92d4df1d41921a1f41e23e499fae9aed48309c443ad41b104fb5bb840e |