azrael 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- azrael-1.0.0/.github/workflows/ci.yml +90 -0
- azrael-1.0.0/.gitignore +20 -0
- azrael-1.0.0/Cargo.lock +133 -0
- azrael-1.0.0/Cargo.toml +12 -0
- azrael-1.0.0/LICENSE +21 -0
- azrael-1.0.0/PKG-INFO +119 -0
- azrael-1.0.0/README.md +88 -0
- azrael-1.0.0/pyproject.toml +54 -0
- azrael-1.0.0/scripts/bake.py +401 -0
- azrael-1.0.0/src/azrael/__init__.py +140 -0
- azrael-1.0.0/src/azrael/_core.pyi +2 -0
- azrael-1.0.0/src/azrael/_corpus_registry.py +112 -0
- azrael-1.0.0/src/azrael/_data/.gitkeep +0 -0
- azrael-1.0.0/src/azrael/_data/azrael.db.gz +0 -0
- azrael-1.0.0/src/azrael/_query.py +118 -0
- azrael-1.0.0/src/lib.rs +41 -0
- azrael-1.0.0/tests/__init__.py +0 -0
- azrael-1.0.0/tests/conftest.py +169 -0
- azrael-1.0.0/tests/test_corpus_registry.py +62 -0
- azrael-1.0.0/tests/test_query.py +369 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
tags: ['v*']
|
|
7
|
+
pull_request:
|
|
8
|
+
branches: [main]
|
|
9
|
+
|
|
10
|
+
env:
|
|
11
|
+
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
test:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: '3.11'
|
|
21
|
+
- uses: dtolnay/rust-toolchain@stable
|
|
22
|
+
- name: Build wheel
|
|
23
|
+
run: |
|
|
24
|
+
pip install maturin
|
|
25
|
+
maturin build --out dist
|
|
26
|
+
pip install --find-links dist azrael
|
|
27
|
+
- name: Run tests
|
|
28
|
+
run: pip install pytest && pytest tests/ -q
|
|
29
|
+
|
|
30
|
+
build-wheels:
|
|
31
|
+
needs: test
|
|
32
|
+
if: startsWith(github.ref, 'refs/tags/v')
|
|
33
|
+
strategy:
|
|
34
|
+
matrix:
|
|
35
|
+
include:
|
|
36
|
+
- os: ubuntu-latest
|
|
37
|
+
target: x86_64
|
|
38
|
+
- os: windows-latest
|
|
39
|
+
target: x86_64
|
|
40
|
+
- os: macos-latest
|
|
41
|
+
target: x86_64
|
|
42
|
+
- os: macos-latest
|
|
43
|
+
target: aarch64
|
|
44
|
+
runs-on: ${{ matrix.os }}
|
|
45
|
+
steps:
|
|
46
|
+
- uses: actions/checkout@v4
|
|
47
|
+
- uses: PyO3/maturin-action@v1
|
|
48
|
+
with:
|
|
49
|
+
target: ${{ matrix.target }}
|
|
50
|
+
args: --release --out dist --find-interpreter
|
|
51
|
+
sccache: 'true'
|
|
52
|
+
manylinux: auto
|
|
53
|
+
- uses: actions/upload-artifact@v4
|
|
54
|
+
with:
|
|
55
|
+
name: wheels-${{ matrix.os }}-${{ matrix.target }}
|
|
56
|
+
path: dist/
|
|
57
|
+
|
|
58
|
+
sdist:
|
|
59
|
+
needs: test
|
|
60
|
+
if: startsWith(github.ref, 'refs/tags/v')
|
|
61
|
+
runs-on: ubuntu-latest
|
|
62
|
+
steps:
|
|
63
|
+
- uses: actions/checkout@v4
|
|
64
|
+
- uses: PyO3/maturin-action@v1
|
|
65
|
+
with:
|
|
66
|
+
command: sdist
|
|
67
|
+
args: --out dist
|
|
68
|
+
- uses: actions/upload-artifact@v4
|
|
69
|
+
with:
|
|
70
|
+
name: sdist
|
|
71
|
+
path: dist/
|
|
72
|
+
|
|
73
|
+
publish:
|
|
74
|
+
needs: [build-wheels, sdist]
|
|
75
|
+
if: startsWith(github.ref, 'refs/tags/v')
|
|
76
|
+
runs-on: ubuntu-latest
|
|
77
|
+
environment: pypi
|
|
78
|
+
permissions:
|
|
79
|
+
id-token: write
|
|
80
|
+
steps:
|
|
81
|
+
- uses: actions/download-artifact@v4
|
|
82
|
+
with:
|
|
83
|
+
pattern: wheels-*
|
|
84
|
+
merge-multiple: true
|
|
85
|
+
path: dist/
|
|
86
|
+
- uses: actions/download-artifact@v4
|
|
87
|
+
with:
|
|
88
|
+
name: sdist
|
|
89
|
+
path: dist/
|
|
90
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
azrael-1.0.0/.gitignore
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
__pycache__/
|
|
2
|
+
*.py[cod]
|
|
3
|
+
*.egg-info/
|
|
4
|
+
build/
|
|
5
|
+
dist/
|
|
6
|
+
target/
|
|
7
|
+
Cargo.lock
|
|
8
|
+
.venv/
|
|
9
|
+
venv/
|
|
10
|
+
|
|
11
|
+
# Uncompressed database — commit the .db.gz, not the raw .db
|
|
12
|
+
src/azrael/_data/*.db
|
|
13
|
+
|
|
14
|
+
# Firebase credentials — NEVER commit these
|
|
15
|
+
*firebase-adminsdk*.json
|
|
16
|
+
*service-account*.json
|
|
17
|
+
*serviceAccount*.json
|
|
18
|
+
serviceAccountKey.json
|
|
19
|
+
credentials*.json
|
|
20
|
+
*-credentials.json
|
azrael-1.0.0/Cargo.lock
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# This file is automatically @generated by Cargo.
|
|
2
|
+
# It is not intended for manual editing.
|
|
3
|
+
version = 4
|
|
4
|
+
|
|
5
|
+
[[package]]
|
|
6
|
+
name = "azrael-core"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
dependencies = [
|
|
9
|
+
"pyo3",
|
|
10
|
+
]
|
|
11
|
+
|
|
12
|
+
[[package]]
|
|
13
|
+
name = "heck"
|
|
14
|
+
version = "0.5.0"
|
|
15
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
16
|
+
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
|
17
|
+
|
|
18
|
+
[[package]]
|
|
19
|
+
name = "libc"
|
|
20
|
+
version = "0.2.186"
|
|
21
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
22
|
+
checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
|
|
23
|
+
|
|
24
|
+
[[package]]
|
|
25
|
+
name = "once_cell"
|
|
26
|
+
version = "1.21.4"
|
|
27
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
28
|
+
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
|
|
29
|
+
|
|
30
|
+
[[package]]
|
|
31
|
+
name = "portable-atomic"
|
|
32
|
+
version = "1.13.1"
|
|
33
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
34
|
+
checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
|
|
35
|
+
|
|
36
|
+
[[package]]
|
|
37
|
+
name = "proc-macro2"
|
|
38
|
+
version = "1.0.106"
|
|
39
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
40
|
+
checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
|
|
41
|
+
dependencies = [
|
|
42
|
+
"unicode-ident",
|
|
43
|
+
]
|
|
44
|
+
|
|
45
|
+
[[package]]
|
|
46
|
+
name = "pyo3"
|
|
47
|
+
version = "0.28.3"
|
|
48
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
49
|
+
checksum = "91fd8e38a3b50ed1167fb981cd6fd60147e091784c427b8f7183a7ee32c31c12"
|
|
50
|
+
dependencies = [
|
|
51
|
+
"libc",
|
|
52
|
+
"once_cell",
|
|
53
|
+
"portable-atomic",
|
|
54
|
+
"pyo3-build-config",
|
|
55
|
+
"pyo3-ffi",
|
|
56
|
+
"pyo3-macros",
|
|
57
|
+
]
|
|
58
|
+
|
|
59
|
+
[[package]]
|
|
60
|
+
name = "pyo3-build-config"
|
|
61
|
+
version = "0.28.3"
|
|
62
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
63
|
+
checksum = "e368e7ddfdeb98c9bca7f8383be1648fd84ab466bf2bc015e94008db6d35611e"
|
|
64
|
+
dependencies = [
|
|
65
|
+
"target-lexicon",
|
|
66
|
+
]
|
|
67
|
+
|
|
68
|
+
[[package]]
|
|
69
|
+
name = "pyo3-ffi"
|
|
70
|
+
version = "0.28.3"
|
|
71
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
72
|
+
checksum = "7f29e10af80b1f7ccaf7f69eace800a03ecd13e883acfacc1e5d0988605f651e"
|
|
73
|
+
dependencies = [
|
|
74
|
+
"libc",
|
|
75
|
+
"pyo3-build-config",
|
|
76
|
+
]
|
|
77
|
+
|
|
78
|
+
[[package]]
|
|
79
|
+
name = "pyo3-macros"
|
|
80
|
+
version = "0.28.3"
|
|
81
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
82
|
+
checksum = "df6e520eff47c45997d2fc7dd8214b25dd1310918bbb2642156ef66a67f29813"
|
|
83
|
+
dependencies = [
|
|
84
|
+
"proc-macro2",
|
|
85
|
+
"pyo3-macros-backend",
|
|
86
|
+
"quote",
|
|
87
|
+
"syn",
|
|
88
|
+
]
|
|
89
|
+
|
|
90
|
+
[[package]]
|
|
91
|
+
name = "pyo3-macros-backend"
|
|
92
|
+
version = "0.28.3"
|
|
93
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
94
|
+
checksum = "c4cdc218d835738f81c2338f822078af45b4afdf8b2e33cbb5916f108b813acb"
|
|
95
|
+
dependencies = [
|
|
96
|
+
"heck",
|
|
97
|
+
"proc-macro2",
|
|
98
|
+
"pyo3-build-config",
|
|
99
|
+
"quote",
|
|
100
|
+
"syn",
|
|
101
|
+
]
|
|
102
|
+
|
|
103
|
+
[[package]]
|
|
104
|
+
name = "quote"
|
|
105
|
+
version = "1.0.45"
|
|
106
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
107
|
+
checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
|
|
108
|
+
dependencies = [
|
|
109
|
+
"proc-macro2",
|
|
110
|
+
]
|
|
111
|
+
|
|
112
|
+
[[package]]
|
|
113
|
+
name = "syn"
|
|
114
|
+
version = "2.0.117"
|
|
115
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
116
|
+
checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
|
|
117
|
+
dependencies = [
|
|
118
|
+
"proc-macro2",
|
|
119
|
+
"quote",
|
|
120
|
+
"unicode-ident",
|
|
121
|
+
]
|
|
122
|
+
|
|
123
|
+
[[package]]
|
|
124
|
+
name = "target-lexicon"
|
|
125
|
+
version = "0.13.5"
|
|
126
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
127
|
+
checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
|
|
128
|
+
|
|
129
|
+
[[package]]
|
|
130
|
+
name = "unicode-ident"
|
|
131
|
+
version = "1.0.24"
|
|
132
|
+
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
133
|
+
checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
|
azrael-1.0.0/Cargo.toml
ADDED
azrael-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Andrew Watts
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
azrael-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: azrael
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
5
|
+
Classifier: Intended Audience :: Developers
|
|
6
|
+
Classifier: Programming Language :: Python :: 3
|
|
7
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
8
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
11
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Topic :: Database
|
|
14
|
+
Classifier: Topic :: Games/Entertainment
|
|
15
|
+
Requires-Dist: eyecore>=1.0.0
|
|
16
|
+
Requires-Dist: requests>=2.28 ; extra == 'bake'
|
|
17
|
+
Requires-Dist: pytest>=7.0 ; extra == 'test'
|
|
18
|
+
Requires-Dist: pytest-cov>=4.0 ; extra == 'test'
|
|
19
|
+
Provides-Extra: bake
|
|
20
|
+
Provides-Extra: test
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Summary: Mythology encyclopedia — gods, creatures, heroes, places, items, and more
|
|
23
|
+
Keywords: mythology,gods,encyclopedia,folklore,creatures,heroes
|
|
24
|
+
Author-email: Andrew Watts <andrewkwatts@gmail.com>
|
|
25
|
+
Requires-Python: >=3.10
|
|
26
|
+
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
27
|
+
Project-URL: Homepage, https://github.com/andrewkwatts-maker/Azrael
|
|
28
|
+
Project-URL: Issues, https://github.com/andrewkwatts-maker/Azrael/issues
|
|
29
|
+
Project-URL: Repository, https://github.com/andrewkwatts-maker/Azrael
|
|
30
|
+
|
|
31
|
+
# azrael
|
|
32
|
+
|
|
33
|
+
Mythology encyclopedia for Python — gods, creatures, heroes, places, items, sacred texts, and more from world mythologies.
|
|
34
|
+
|
|
35
|
+
## Features
|
|
36
|
+
|
|
37
|
+
- Thousands of entities spanning Greek, Norse, Egyptian, Celtic, Hindu, Mesopotamian, Japanese, and more
|
|
38
|
+
- Full-text search with FTS5 fallback to LIKE
|
|
39
|
+
- Fuzzy name matching and random sampling
|
|
40
|
+
- Topic graph for related entity discovery
|
|
41
|
+
- On-demand corpus checkout from Project Gutenberg (downloaded once, cached locally)
|
|
42
|
+
- Optional LLM integration for intelligent queries
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pip install azrael
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Quick start
|
|
51
|
+
|
|
52
|
+
```python
|
|
53
|
+
import azrael
|
|
54
|
+
|
|
55
|
+
# Look up by type
|
|
56
|
+
god = azrael.GetGod("Odin")
|
|
57
|
+
creature = azrael.GetCreature("Hydra")
|
|
58
|
+
hero = azrael.GetHero("Achilles")
|
|
59
|
+
place = azrael.GetPlace("Valhalla")
|
|
60
|
+
item = azrael.GetItem("Mjolnir")
|
|
61
|
+
|
|
62
|
+
# Generic lookup and full-text search
|
|
63
|
+
entry = azrael.Get("Fenrir")
|
|
64
|
+
results = azrael.Search("trickster")
|
|
65
|
+
|
|
66
|
+
# Browse by mythology or type
|
|
67
|
+
norse = azrael.ByMythology("norse")
|
|
68
|
+
deities = azrael.ByType("deity", "greek")
|
|
69
|
+
all_gods = azrael.AllGods("egyptian")
|
|
70
|
+
|
|
71
|
+
# Random, fuzzy, and statistics
|
|
72
|
+
random_ = azrael.GetRandom("creature")
|
|
73
|
+
matches = azrael.GetFuzzy("thor")
|
|
74
|
+
popular = azrael.GetMost("mythology")
|
|
75
|
+
total = azrael.Count()
|
|
76
|
+
|
|
77
|
+
# Topic graph
|
|
78
|
+
related = azrael.GetRelated("Zeus")
|
|
79
|
+
topics = azrael.GetTopics("greek")
|
|
80
|
+
tree = azrael.GetTopicTree("olympian")
|
|
81
|
+
|
|
82
|
+
# Corpus — downloads from Project Gutenberg on first use
|
|
83
|
+
azrael.FetchCorpus("gutenberg-iliad")
|
|
84
|
+
hits = azrael.SearchCorpus("wooden horse")
|
|
85
|
+
sources = azrael.ListCorpuses()
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Available corpuses
|
|
89
|
+
|
|
90
|
+
| Corpus ID | Text |
|
|
91
|
+
|---|---|
|
|
92
|
+
| `gutenberg-iliad` | Homer's Iliad |
|
|
93
|
+
| `gutenberg-odyssey` | Homer's Odyssey |
|
|
94
|
+
| `gutenberg-theogony` | Hesiod's Theogony |
|
|
95
|
+
| `gutenberg-metamorphoses` | Ovid's Metamorphoses |
|
|
96
|
+
| `gutenberg-aeneid` | Virgil's Aeneid |
|
|
97
|
+
| `gutenberg-homeric-hymns` | Homeric Hymns |
|
|
98
|
+
| `gutenberg-prose-edda` | Snorri Sturluson's Prose Edda |
|
|
99
|
+
| `gutenberg-volsunga-saga` | Volsunga Saga |
|
|
100
|
+
| `gutenberg-mabinogion` | The Mabinogion (Welsh myths) |
|
|
101
|
+
| `gutenberg-celtic-myth` | Celtic Myth and Legend |
|
|
102
|
+
| `gutenberg-egyptian-myth` | Egyptian Myth and Legend |
|
|
103
|
+
| `gutenberg-1001-nights` | One Thousand and One Nights |
|
|
104
|
+
| `gutenberg-ramayana` | The Ramayana |
|
|
105
|
+
| `gutenberg-mahabharata` | The Mahabharata |
|
|
106
|
+
|
|
107
|
+
## Part of the Eyes of Azrael suite
|
|
108
|
+
|
|
109
|
+
| Package | Description |
|
|
110
|
+
|---|---|
|
|
111
|
+
| [`eyecore`](https://github.com/EyesOfAzrael/eyecore) | Shared foundation (DB, graph, corpus, LLM) |
|
|
112
|
+
| [`clio`](https://github.com/EyesOfAzrael/clio) | Historical figures and events |
|
|
113
|
+
| [`apocrypha`](https://github.com/EyesOfAzrael/apocrypha) | Conspiracy theories and hidden histories |
|
|
114
|
+
| [`augur`](https://github.com/EyesOfAzrael/augur) | News aggregation and topic analysis |
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
MIT — see [LICENSE](LICENSE)
|
|
119
|
+
|
azrael-1.0.0/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# azrael
|
|
2
|
+
|
|
3
|
+
Mythology encyclopedia for Python — gods, creatures, heroes, places, items, sacred texts, and more from world mythologies.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Thousands of entities spanning Greek, Norse, Egyptian, Celtic, Hindu, Mesopotamian, Japanese, and more
|
|
8
|
+
- Full-text search with FTS5 fallback to LIKE
|
|
9
|
+
- Fuzzy name matching and random sampling
|
|
10
|
+
- Topic graph for related entity discovery
|
|
11
|
+
- On-demand corpus checkout from Project Gutenberg (downloaded once, cached locally)
|
|
12
|
+
- Optional LLM integration for intelligent queries
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
pip install azrael
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```python
|
|
23
|
+
import azrael
|
|
24
|
+
|
|
25
|
+
# Look up by type
|
|
26
|
+
god = azrael.GetGod("Odin")
|
|
27
|
+
creature = azrael.GetCreature("Hydra")
|
|
28
|
+
hero = azrael.GetHero("Achilles")
|
|
29
|
+
place = azrael.GetPlace("Valhalla")
|
|
30
|
+
item = azrael.GetItem("Mjolnir")
|
|
31
|
+
|
|
32
|
+
# Generic lookup and full-text search
|
|
33
|
+
entry = azrael.Get("Fenrir")
|
|
34
|
+
results = azrael.Search("trickster")
|
|
35
|
+
|
|
36
|
+
# Browse by mythology or type
|
|
37
|
+
norse = azrael.ByMythology("norse")
|
|
38
|
+
deities = azrael.ByType("deity", "greek")
|
|
39
|
+
all_gods = azrael.AllGods("egyptian")
|
|
40
|
+
|
|
41
|
+
# Random, fuzzy, and statistics
|
|
42
|
+
random_ = azrael.GetRandom("creature")
|
|
43
|
+
matches = azrael.GetFuzzy("thor")
|
|
44
|
+
popular = azrael.GetMost("mythology")
|
|
45
|
+
total = azrael.Count()
|
|
46
|
+
|
|
47
|
+
# Topic graph
|
|
48
|
+
related = azrael.GetRelated("Zeus")
|
|
49
|
+
topics = azrael.GetTopics("greek")
|
|
50
|
+
tree = azrael.GetTopicTree("olympian")
|
|
51
|
+
|
|
52
|
+
# Corpus — downloads from Project Gutenberg on first use
|
|
53
|
+
azrael.FetchCorpus("gutenberg-iliad")
|
|
54
|
+
hits = azrael.SearchCorpus("wooden horse")
|
|
55
|
+
sources = azrael.ListCorpuses()
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Available corpuses
|
|
59
|
+
|
|
60
|
+
| Corpus ID | Text |
|
|
61
|
+
|---|---|
|
|
62
|
+
| `gutenberg-iliad` | Homer's Iliad |
|
|
63
|
+
| `gutenberg-odyssey` | Homer's Odyssey |
|
|
64
|
+
| `gutenberg-theogony` | Hesiod's Theogony |
|
|
65
|
+
| `gutenberg-metamorphoses` | Ovid's Metamorphoses |
|
|
66
|
+
| `gutenberg-aeneid` | Virgil's Aeneid |
|
|
67
|
+
| `gutenberg-homeric-hymns` | Homeric Hymns |
|
|
68
|
+
| `gutenberg-prose-edda` | Snorri Sturluson's Prose Edda |
|
|
69
|
+
| `gutenberg-volsunga-saga` | Volsunga Saga |
|
|
70
|
+
| `gutenberg-mabinogion` | The Mabinogion (Welsh myths) |
|
|
71
|
+
| `gutenberg-celtic-myth` | Celtic Myth and Legend |
|
|
72
|
+
| `gutenberg-egyptian-myth` | Egyptian Myth and Legend |
|
|
73
|
+
| `gutenberg-1001-nights` | One Thousand and One Nights |
|
|
74
|
+
| `gutenberg-ramayana` | The Ramayana |
|
|
75
|
+
| `gutenberg-mahabharata` | The Mahabharata |
|
|
76
|
+
|
|
77
|
+
## Part of the Eyes of Azrael suite
|
|
78
|
+
|
|
79
|
+
| Package | Description |
|
|
80
|
+
|---|---|
|
|
81
|
+
| [`eyecore`](https://github.com/EyesOfAzrael/eyecore) | Shared foundation (DB, graph, corpus, LLM) |
|
|
82
|
+
| [`clio`](https://github.com/EyesOfAzrael/clio) | Historical figures and events |
|
|
83
|
+
| [`apocrypha`](https://github.com/EyesOfAzrael/apocrypha) | Conspiracy theories and hidden histories |
|
|
84
|
+
| [`augur`](https://github.com/EyesOfAzrael/augur) | News aggregation and topic analysis |
|
|
85
|
+
|
|
86
|
+
## License
|
|
87
|
+
|
|
88
|
+
MIT — see [LICENSE](LICENSE)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["maturin>=1.4,<2.0"]
|
|
3
|
+
build-backend = "maturin"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "azrael"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
description = "Mythology encyclopedia — gods, creatures, heroes, places, items, and more"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = {file = "LICENSE"}
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "Andrew Watts", email = "andrewkwatts@gmail.com"},
|
|
14
|
+
]
|
|
15
|
+
keywords = ["mythology", "gods", "encyclopedia", "folklore", "creatures", "heroes"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 5 - Production/Stable",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Programming Language :: Python :: 3.10",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"License :: OSI Approved :: MIT License",
|
|
25
|
+
"Operating System :: OS Independent",
|
|
26
|
+
"Topic :: Database",
|
|
27
|
+
"Topic :: Games/Entertainment",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
dependencies = [
|
|
31
|
+
"eyecore>=1.0.0",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[project.optional-dependencies]
|
|
35
|
+
bake = [
|
|
36
|
+
"requests>=2.28",
|
|
37
|
+
]
|
|
38
|
+
test = [
|
|
39
|
+
"pytest>=7.0",
|
|
40
|
+
"pytest-cov>=4.0",
|
|
41
|
+
]
|
|
42
|
+
|
|
43
|
+
[project.urls]
|
|
44
|
+
Homepage = "https://github.com/andrewkwatts-maker/Azrael"
|
|
45
|
+
Repository = "https://github.com/andrewkwatts-maker/Azrael"
|
|
46
|
+
Issues = "https://github.com/andrewkwatts-maker/Azrael/issues"
|
|
47
|
+
|
|
48
|
+
[tool.maturin]
|
|
49
|
+
python-source = "src"
|
|
50
|
+
module-name = "azrael._core"
|
|
51
|
+
features = ["pyo3/extension-module"]
|
|
52
|
+
|
|
53
|
+
[tool.pytest.ini_options]
|
|
54
|
+
testpaths = ["tests"]
|