-
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
0 parents
commit 84f36d9
Showing
25 changed files
with
188 additions
and
0 deletions.
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,54 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
pip-wheel-metadata/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# pytype static type analyzer | ||
.pytype/ | ||
|
||
# IPython | ||
profile_default/ | ||
ipython_config.py | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# secrets.yaml | ||
secrets.yaml |
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,73 @@ | ||
# Narr_AI_tive 🤖📚 | ||
|
||
[](https://pypi.org/project/narr-ai-tive) | ||
[](https://pypi.org/project/narr-ai-tive) | ||
[](https://github.com/pypa/hatch) | ||
|
||
Transform your storytelling with AI-powered narrative generation. | ||
|
||
## Table of Contents | ||
|
||
- [Features](#-features) | ||
- [Installation](#-installation) | ||
- [Development](#%EF%B8%8F-development) | ||
- [Usage](#-usage) | ||
- [Contributing](#-contributing) | ||
- [License](#-license) | ||
|
||
## ✨ Features | ||
|
||
- 🎯 Intelligent story generation | ||
- 🔄 Context-aware narrative flow | ||
- 🎨 Creative plot development | ||
- ⚡ Fast and efficient processing | ||
|
||
## 🚀 Installation | ||
|
||
```console | ||
pip install narr-ai-tive | ||
``` | ||
|
||
For development installation: | ||
|
||
```console | ||
git clone https://github.com/yourusername/narr-ai-tive.git | ||
cd narr-ai-tive | ||
pip install -e ".[dev]" | ||
``` | ||
|
||
## 🛠️ Development | ||
|
||
This project uses [Hatch](https://hatch.pypa.io/) for project management. To get started: | ||
|
||
```console | ||
pip install hatch | ||
hatch shell | ||
``` | ||
|
||
Common commands: | ||
- `hatch run test` - Run tests | ||
- `hatch run lint` - Run linters | ||
- `hatch build` - Build the package | ||
|
||
## 📖 Usage | ||
|
||
```python | ||
from narr_ai_tive import Generator | ||
|
||
generator = Generator() | ||
story = generator.create_story("A cyberpunk adventure") | ||
print(story) | ||
``` | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions are welcome! Please feel free to submit a Pull Request. | ||
|
||
## 📜 License | ||
|
||
`narr-ai-tive` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. | ||
|
||
--- | ||
|
||
Built with 🥚 [Hatch](https://github.com/pypa/hatch) |
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
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,61 @@ | ||
[build-system] | ||
requires = ["hatchling"] | ||
build-backend = "hatchling.build" | ||
|
||
[project] | ||
name = "narr-ai-tive" | ||
dynamic = ["version"] | ||
description = 'AI Story Gen' | ||
readme = "README.md" | ||
requires-python = ">=3.8" | ||
license = "MIT" | ||
keywords = [] | ||
authors = [ | ||
{ name = "Dustin Smith", email = "[email protected]" }, | ||
] | ||
classifiers = [ | ||
"Development Status :: 4 - Beta", | ||
"Programming Language :: Python", | ||
"Programming Language :: Python :: 3.8", | ||
"Programming Language :: Python :: 3.9", | ||
"Programming Language :: Python :: 3.10", | ||
"Programming Language :: Python :: 3.11", | ||
"Programming Language :: Python :: 3.12", | ||
"Programming Language :: Python :: Implementation :: CPython", | ||
"Programming Language :: Python :: Implementation :: PyPy", | ||
] | ||
dependencies = [] | ||
|
||
[project.urls] | ||
Documentation = "https://github.com/Dustin Smith/narr-ai-tive#readme" | ||
Issues = "https://github.com/Dustin Smith/narr-ai-tive/issues" | ||
Source = "https://github.com/Dustin Smith/narr-ai-tive" | ||
|
||
[tool.hatch.version] | ||
path = "src/narr_ai_tive/__about__.py" | ||
|
||
[tool.hatch.envs.types] | ||
extra-dependencies = [ | ||
"mypy>=1.0.0", | ||
] | ||
[tool.hatch.envs.types.scripts] | ||
check = "mypy --install-types --non-interactive {args:src/narr_ai_tive tests}" | ||
|
||
[tool.coverage.run] | ||
source_pkgs = ["narr_ai_tive", "tests"] | ||
branch = true | ||
parallel = true | ||
omit = [ | ||
"src/narr_ai_tive/__about__.py", | ||
] | ||
|
||
[tool.coverage.paths] | ||
narr_ai_tive = ["src/narr_ai_tive", "*/narr-ai-tive/src/narr_ai_tive"] | ||
tests = ["tests", "*/narr-ai-tive/tests"] | ||
|
||
[tool.coverage.report] | ||
exclude_lines = [ | ||
"no cov", | ||
"if __name__ == .__main__.:", | ||
"if TYPE_CHECKING:", | ||
] |