soseki 0.8.8__tar.gz

soseki-0.8.8/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michał Świtała / CodingMinds.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

soseki-0.8.8/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENCE
+include requirements.txt
+recursive-include ssk/templates *
+recursive-include ssk/static *
+recursive-include ssk/blanco_app *
+recursive-include ssk/blanco_bin *
+recursive-include ssk/blanco_jup *

soseki-0.8.8/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: soseki
+Version: 0.8.8
+Summary: a lightweight foundation for building Python web tools.
+Home-page: https://codingminds.io/soseki
+Author: Michał Świtała
+Author-email: michal@codingminds.io
+License: MIT
+Project-URL: Bug Reports, https://github.com/acodingmind/soseki/issues
+Project-URL: Source, https://github.com/acodingmind/soseki
+Keywords: flask web framework user-management scheduling
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Flask
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask==3.1.2
+Requires-Dist: Flask-Login==0.6.3
+Requires-Dist: Flask-Mail==0.10.0
+Requires-Dist: Flask-SQLAlchemy==3.1.1
+Requires-Dist: Flask-User==1.0.2.2
+Requires-Dist: Flask-WTF==1.2.2
+Requires-Dist: SQLAlchemy==2.0.44
+Requires-Dist: SQLAlchemy-Utils==0.42.0
+Requires-Dist: PyMySQL==1.1.2
+Requires-Dist: APScheduler==3.11.1
+Requires-Dist: WTForms==3.2.1
+Requires-Dist: email-validator==2.3.0
+Requires-Dist: psutil==7.1.3
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: textile==4.0.3
+Requires-Dist: MarkupSafe==3.0.3
+Requires-Dist: requests==2.32.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Soseki
+
+A lightweight, batteries-included Flask framework designed for rapidly building internal tools, admin panels, and data-driven web applications.
+
+Soseki takes care of the repetitive infrastructure—authentication, database management, background jobs, API controls, and logging—so you can focus on building the features that matter. Perfect for prototypes, internal dashboards, and production-ready utilities that need to ship fast without sacrificing structure.
+
+## Features
+
+- 🔐 **User Management** - Complete authentication system with Flask-User
+- 📊 **Database Management** - SQLAlchemy integration with dual database support (app + logs)
+- ⏰ **Job Scheduling** - Background job execution with APScheduler
+- 📧 **Email Support** - Built-in email functionality with Flask-Mail
+- 🔌 **API Gateway** - API key management and rate limiting
+- 📝 **Request Logging** - Comprehensive request/response logging
+- 🛠️ **Database Versioning** - Built-in database migration support
+- 🛠️ **CLI** - interactive command line for quick feature development and testing
+- 🎨 **Customizable** - YAML-based configuration system
+
+## Requirements
+
+- Python 3.10 or higher
+- Flask 3.0+
+- SQLAlchemy 2.0+
+
+## Installation
+
+### From PyPI (coming soon)
+
+```bash
+pip install soseki
+```
+
+### From source
+
+```bash
+git clone https://github.com/acodingmind/soseki
+cd soseki
+pip install -e .
+```
+
+### Development Installation
+
+```bash
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+```
+
+## Quick Start
+
+1. Initialize a new soseki like application:
+
+```bash
+# Create a project folder 
+mkdir soseki_app
+cd soseki_app
+
+# Install soseki
+python3 -m venv venv
+source venv/bin/activate
+pip install soseki
+
+# Initialize basic soseki app
+python3 -m ssk.cli init
+```
+
+2. Update configuration file (`cfg/lite.yaml`):
+
+```yaml
+ssk:
+  USER_APP_NAME:
+    string: 'MyApp'
+  SECRET_KEY:
+    string: 'your-secret-key-here'
+  SQLALCHEMY_DATABASE_URI:
+    string: 'sqlite:///myapp.sqlite'
+  LOG_DB_CONNSTR:
+    string: 'sqlite:///myapp_log.sqlite'
+```
+
+3. Run your application:
+
+```bash
+# run the app
+./bin/run_app.sh
+```
+
+## Documentation
+
+- [Installation Guide](https://github.com/acodingmind/soseki/blob/release/docs/installation.md)
+- [Quick Start](https://github.com/acodingmind/soseki/blob/release/docs/quickstart.md)
+- [Configuration](https://github.com/acodingmind/soseki/blob/release/docs/configuration.md)
+
+## How To
+
+- [How To Add Notes](https://github.com/acodingmind/soseki/blob/release/docs/how-to-add-notes.md)
+- [How To Upgrade Database](https://github.com/acodingmind/soseki/blob/release/docs/how-to-database-upgrade.md)
+
+## Blanco App
+
+Check the `app/` directory for a complete working example application.
+
+The standard folder structure (created by init command):
+- `assets/local` - Static files (CSS, JS)
+- `blueprints/` - Flask blueprints
+- `cfg/` - Configuration files
+- `html/local` - Templates
+- `logic/cmd` - Custom commands
+- `logic/jobs` - Background jobs
+- `models/` - Database models
+
+## Project Structure
+
+```
+soseki/
+├── ssk/              # Core framework package
+├── app/              # Blanco application
+├── bin/              # Utility scripts
+├── tests/            # Test suite
+├── docs/             # Documentation
+└── requirements.txt  # Core dependencies
+```
+
+## Running Tests
+
+```bash
+pytest
+```
+
+With coverage:
+
+```bash
+pytest --cov=ssk
+```
+
+## License
+
+MIT License - see [LICENCE](https://github.com/acodingmind/soseki/blob/release/LICENSE) file for details.
+
+## Author
+
+Michał Świtała - [CodingMinds.io](https://codingminds.io)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+- [How Contribute](https://github.com/acodingmind/soseki/blob/release/CONTRIBUTING.md)
+
+## Support
+
+For issues and questions, please use the [GitHub issue tracker](https://github.com/acodingmind/soseki/issues).

soseki-0.8.8/README.md

@@ -0,0 +1,151 @@
+# Soseki
+
+A lightweight, batteries-included Flask framework designed for rapidly building internal tools, admin panels, and data-driven web applications.
+
+Soseki takes care of the repetitive infrastructure—authentication, database management, background jobs, API controls, and logging—so you can focus on building the features that matter. Perfect for prototypes, internal dashboards, and production-ready utilities that need to ship fast without sacrificing structure.
+
+## Features
+
+- 🔐 **User Management** - Complete authentication system with Flask-User
+- 📊 **Database Management** - SQLAlchemy integration with dual database support (app + logs)
+- ⏰ **Job Scheduling** - Background job execution with APScheduler
+- 📧 **Email Support** - Built-in email functionality with Flask-Mail
+- 🔌 **API Gateway** - API key management and rate limiting
+- 📝 **Request Logging** - Comprehensive request/response logging
+- 🛠️ **Database Versioning** - Built-in database migration support
+- 🛠️ **CLI** - interactive command line for quick feature development and testing
+- 🎨 **Customizable** - YAML-based configuration system
+
+## Requirements
+
+- Python 3.10 or higher
+- Flask 3.0+
+- SQLAlchemy 2.0+
+
+## Installation
+
+### From PyPI (coming soon)
+
+```bash
+pip install soseki
+```
+
+### From source
+
+```bash
+git clone https://github.com/acodingmind/soseki
+cd soseki
+pip install -e .
+```
+
+### Development Installation
+
+```bash
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+```
+
+## Quick Start
+
+1. Initialize a new soseki like application:
+
+```bash
+# Create a project folder 
+mkdir soseki_app
+cd soseki_app
+
+# Install soseki
+python3 -m venv venv
+source venv/bin/activate
+pip install soseki
+
+# Initialize basic soseki app
+python3 -m ssk.cli init
+```
+
+2. Update configuration file (`cfg/lite.yaml`):
+
+```yaml
+ssk:
+  USER_APP_NAME:
+    string: 'MyApp'
+  SECRET_KEY:
+    string: 'your-secret-key-here'
+  SQLALCHEMY_DATABASE_URI:
+    string: 'sqlite:///myapp.sqlite'
+  LOG_DB_CONNSTR:
+    string: 'sqlite:///myapp_log.sqlite'
+```
+
+3. Run your application:
+
+```bash
+# run the app
+./bin/run_app.sh
+```
+
+## Documentation
+
+- [Installation Guide](https://github.com/acodingmind/soseki/blob/release/docs/installation.md)
+- [Quick Start](https://github.com/acodingmind/soseki/blob/release/docs/quickstart.md)
+- [Configuration](https://github.com/acodingmind/soseki/blob/release/docs/configuration.md)
+
+## How To
+
+- [How To Add Notes](https://github.com/acodingmind/soseki/blob/release/docs/how-to-add-notes.md)
+- [How To Upgrade Database](https://github.com/acodingmind/soseki/blob/release/docs/how-to-database-upgrade.md)
+
+## Blanco App
+
+Check the `app/` directory for a complete working example application.
+
+The standard folder structure (created by init command):
+- `assets/local` - Static files (CSS, JS)
+- `blueprints/` - Flask blueprints
+- `cfg/` - Configuration files
+- `html/local` - Templates
+- `logic/cmd` - Custom commands
+- `logic/jobs` - Background jobs
+- `models/` - Database models
+
+## Project Structure
+
+```
+soseki/
+├── ssk/              # Core framework package
+├── app/              # Blanco application
+├── bin/              # Utility scripts
+├── tests/            # Test suite
+├── docs/             # Documentation
+└── requirements.txt  # Core dependencies
+```
+
+## Running Tests
+
+```bash
+pytest
+```
+
+With coverage:
+
+```bash
+pytest --cov=ssk
+```
+
+## License
+
+MIT License - see [LICENCE](https://github.com/acodingmind/soseki/blob/release/LICENSE) file for details.
+
+## Author
+
+Michał Świtała - [CodingMinds.io](https://codingminds.io)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+- [How Contribute](https://github.com/acodingmind/soseki/blob/release/CONTRIBUTING.md)
+
+## Support
+
+For issues and questions, please use the [GitHub issue tracker](https://github.com/acodingmind/soseki/issues).

soseki-0.8.8/requirements.txt

@@ -0,0 +1,27 @@
+# Core framework dependencies
+Flask==3.1.2
+Flask-Login==0.6.3
+Flask-Mail==0.10.0
+Flask-SQLAlchemy==3.1.1
+Flask-User==1.0.2.2
+Flask-WTF==1.2.2
+
+# Database
+SQLAlchemy==2.0.44
+SQLAlchemy-Utils==0.42.0
+PyMySQL==1.1.2
+
+# Scheduling
+APScheduler==3.11.1
+
+# Forms and validation
+WTForms==3.2.1
+email-validator==2.3.0
+
+# Utilities
+psutil==7.1.3
+PyYAML==6.0.3
+textile==4.0.3
+MarkupSafe==3.0.3
+requests==2.32.5
+

soseki-0.8.8/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

soseki-0.8.8/setup.py

@@ -0,0 +1,149 @@
+#
+# Copyright (c) 2023 Michał Świtała / CodingMinds.io
+# SPDX-License-Identifier: MIT
+#
+
+
+from setuptools import setup, find_packages
+from setuptools.command.build_py import build_py
+from setuptools.command.sdist import sdist
+import re
+import os
+import shutil
+
+def sync_blanco_app():
+    """Copy app directory to ssk/blanco_app before building."""
+    app_dir = 'app'
+    blanco_app_dir = 'ssk/blanco_app'
+    
+    if os.path.exists(app_dir):
+        # Remove existing blanco_app if it exists
+        if os.path.exists(blanco_app_dir):
+            shutil.rmtree(blanco_app_dir)
+        
+        # Copy app to blanco_app, excluding templates and static
+        def ignore_patterns(dir, files):
+            # Ignore templates and static directories at the root level
+            if dir == app_dir:
+                return {'templates', 'static'}
+            return set()
+        
+        shutil.copytree(app_dir, blanco_app_dir, ignore=ignore_patterns)
+        print(f"Synced {app_dir}/ to {blanco_app_dir}/ (excluding templates and static)")
+    else:
+        print(f"Warning: {app_dir}/ directory not found, skipping sync")
+    
+    # Sync bin directory
+    bin_dir = 'bin'
+    blanco_bin_dir = 'ssk/blanco_bin'
+    
+    if os.path.exists(bin_dir):
+        if os.path.exists(blanco_bin_dir):
+            shutil.rmtree(blanco_bin_dir)
+        shutil.copytree(bin_dir, blanco_bin_dir)
+        print(f"Synced {bin_dir}/ to {blanco_bin_dir}/")
+    else:
+        print(f"Warning: {bin_dir}/ directory not found, skipping sync")
+    
+    # Sync jup directory
+    jup_dir = 'jup'
+    blanco_jup_dir = 'ssk/blanco_jup'
+    
+    if os.path.exists(jup_dir):
+        if os.path.exists(blanco_jup_dir):
+            shutil.rmtree(blanco_jup_dir)
+        shutil.copytree(jup_dir, blanco_jup_dir)
+        print(f"Synced {jup_dir}/ to {blanco_jup_dir}/")
+    else:
+        print(f"Warning: {jup_dir}/ directory not found, skipping sync")
+
+
+class CustomBuildPy(build_py):
+    """Custom build command that syncs blanco_app before building."""
+    def run(self):
+        sync_blanco_app()
+        build_py.run(self)
+
+
+class CustomSdist(sdist):
+    """Custom sdist command that syncs blanco_app before creating source distribution."""
+    def run(self):
+        sync_blanco_app()
+        sdist.run(self)
+
+
+# Read version without importing the module
+with open('ssk/ssk_consts.py', 'r') as f:
+    version_file = f.read()
+    version_match = re.search(r"^SSK_VER = ['\"]([^'\"]*)['\"]", version_file, re.M)
+    if version_match:
+        SSK_VER = version_match.group(1)
+    else:
+        raise RuntimeError("Unable to find version string.")
+
+# Read long description from README
+with open('README.md', 'r', encoding='utf-8') as f:
+    long_description = f.read()
+
+# Read requirements
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
+# Filter out comments and empty lines
+install_requires = []
+for req in requirements:
+    req = req.strip()
+    if req and not req.startswith('#'):
+        install_requires.append(req)
+
+setup(
+    name='soseki',
+    version=SSK_VER,
+    description='a lightweight foundation for building Python web tools.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://codingminds.io/soseki',
+    author='Michał Świtała',
+    author_email='michal@codingminds.io',
+    license='MIT',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
+        'Framework :: Flask',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+        'Topic :: Software Development :: Libraries :: Application Frameworks',
+    ],
+    keywords='flask web framework user-management scheduling',
+    packages=find_packages(exclude=['tests', 'tests.*', 'app', 'app.*', 'scripts', 'jup', 'docs']),
+    python_requires='>=3.10',
+    install_requires=install_requires,
+    package_data={
+        'ssk': [
+            'templates/**/*',
+            'static/**/*',
+            'blanco_app/**/*',
+            'blanco_bin/**/*',
+            'blanco_jup/**/*',
+        ]
+    },
+    include_package_data=True,
+    zip_safe=False,
+    cmdclass={
+        'build_py': CustomBuildPy,
+        'sdist': CustomSdist,
+    },
+    entry_points={
+        'console_scripts': [
+            'soseki=ssk.cli:cli',
+        ],
+    },
+    project_urls={
+        'Bug Reports': 'https://github.com/acodingmind/soseki/issues',
+        'Source': 'https://github.com/acodingmind/soseki',
+    },
+)