jgtcore 0.1.0__tar.gz

jgtcore-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Guillaume Descoteaux-Isabelle
+
+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.

jgtcore-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: jgtcore
+Version: 0.1.0
+Summary: Core library for JGT utilities - configuration, settings, and utility functions
+Author-email: Guillaume Isabelle <jgi@jgwill.com>
+License: MIT
+Project-URL: Homepage, https://github.com/jgwill/jgtcore
+Project-URL: Bug Tracker, https://github.com/jgwill/jgtcore/issues
+Project-URL: Documentation, https://github.com/jgwill/jgtcore#readme
+Project-URL: Source Code, https://github.com/jgwill/jgtcore
+Keywords: configuration,settings,utilities,jgt
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# jgtcore
+
+Core library for JGT utilities - configuration, settings, and utility functions.
+
+This is a pure Python library extracted from `jgtutils` to provide clean programmatic access to JGT configuration and settings without CLI dependencies.
+
+## Installation
+
+```bash
+pip install jgtcore
+```
+
+## Usage
+
+### Simple Configuration Access
+```python
+import jgtcore
+
+# Load configuration
+config = jgtcore.get_config()
+demo_config = jgtcore.get_config(demo=True)
+
+# Get specific config values
+user_id = jgtcore.get_config_value('user_id')
+quotes_count = jgtcore.get_config_value('quotes_count', 1000)
+```
+
+### Settings Management
+```python
+import jgtcore
+
+# Get all settings
+settings = jgtcore.get_settings()
+
+# Get specific setting with default
+instrument = jgtcore.get_setting('instrument', 'EUR/USD')
+timeframes = jgtcore.get_setting('_timeframes', 'D1')
+```
+
+### Environment Setup
+```python
+import jgtcore
+
+# One-call environment setup
+config, settings = jgtcore.setup_environment(demo=True)
+
+# Check demo mode
+if jgtcore.is_demo_mode():
+    print("Running in demo mode")
+```
+
+### Advanced Usage
+```python
+from jgtcore import readconfig, load_settings
+
+# Load with specific options
+config = readconfig(demo=True, export_env=True)
+settings = load_settings(custom_path="/path/to/settings.json")
+```
+
+## Configuration Files
+
+- **config.json**: Trading credentials and connection settings
+- **settings.json**: Application settings and preferences
+
+See `examples/` directory for sample configuration files.
+
+## File Locations
+
+### config.json lookup order:
+1. Current directory: `config.json`
+2. User home: `~/.jgt/config.json`
+3. System: `/etc/jgt/config.json`
+4. Environment variables: `JGT_CONFIG`, `JGT_CONFIG_PATH`
+
+### settings.json lookup order:
+1. System: `/etc/jgt/settings.json`
+2. User home: `~/.jgt/settings.json`
+3. Current directory: `.jgt/settings.json`
+4. YAML variants: `jgt.yml`, `_config.yml`
+5. Environment variables: `JGT_SETTINGS`
+
+## License
+
+MIT License

jgtcore-0.1.0/README.md

@@ -0,0 +1,85 @@
+# jgtcore
+
+Core library for JGT utilities - configuration, settings, and utility functions.
+
+This is a pure Python library extracted from `jgtutils` to provide clean programmatic access to JGT configuration and settings without CLI dependencies.
+
+## Installation
+
+```bash
+pip install jgtcore
+```
+
+## Usage
+
+### Simple Configuration Access
+```python
+import jgtcore
+
+# Load configuration
+config = jgtcore.get_config()
+demo_config = jgtcore.get_config(demo=True)
+
+# Get specific config values
+user_id = jgtcore.get_config_value('user_id')
+quotes_count = jgtcore.get_config_value('quotes_count', 1000)
+```
+
+### Settings Management
+```python
+import jgtcore
+
+# Get all settings
+settings = jgtcore.get_settings()
+
+# Get specific setting with default
+instrument = jgtcore.get_setting('instrument', 'EUR/USD')
+timeframes = jgtcore.get_setting('_timeframes', 'D1')
+```
+
+### Environment Setup
+```python
+import jgtcore
+
+# One-call environment setup
+config, settings = jgtcore.setup_environment(demo=True)
+
+# Check demo mode
+if jgtcore.is_demo_mode():
+    print("Running in demo mode")
+```
+
+### Advanced Usage
+```python
+from jgtcore import readconfig, load_settings
+
+# Load with specific options
+config = readconfig(demo=True, export_env=True)
+settings = load_settings(custom_path="/path/to/settings.json")
+```
+
+## Configuration Files
+
+- **config.json**: Trading credentials and connection settings
+- **settings.json**: Application settings and preferences
+
+See `examples/` directory for sample configuration files.
+
+## File Locations
+
+### config.json lookup order:
+1. Current directory: `config.json`
+2. User home: `~/.jgt/config.json`
+3. System: `/etc/jgt/config.json`
+4. Environment variables: `JGT_CONFIG`, `JGT_CONFIG_PATH`
+
+### settings.json lookup order:
+1. System: `/etc/jgt/settings.json`
+2. User home: `~/.jgt/settings.json`
+3. Current directory: `.jgt/settings.json`
+4. YAML variants: `jgt.yml`, `_config.yml`
+5. Environment variables: `JGT_SETTINGS`
+
+## License
+
+MIT License

jgtcore-0.1.0/jgtcore/__init__.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+
+"""
+jgtcore - Core library functions extracted from jgtutils
+
+This module provides the core configuration, settings, and utility functions
+from jgtutils without CLI dependencies, making them suitable for use in
+other libraries and applications.
+
+Main Functions:
+- Configuration: readconfig(), get_config(), get_config_value()
+- Settings: load_settings(), get_settings(), get_setting()
+- Environment: setup_environment(), export_env_if_any()
+- Utilities: str_to_datetime(), is_market_open(), print_exception()
+- Trading: read_fx_str_from_config(), is_demo_mode()
+"""
+
+from .core import (
+    # Core configuration functions
+    readconfig,
+    load_settings,
+    get_settings,
+    
+    # Simple API wrappers
+    get_config,
+    get_setting,
+    setup_environment,
+    get_config_value,
+    is_demo_mode,
+    
+    # Environment helpers
+    load_arg_from_jgt_env,
+    load_arg_default_from_settings,
+    export_env_if_any,
+    
+    # Utility functions
+    str_to_datetime,
+    print_exception,
+    is_market_open,
+    dt_from_last_week_as_datetime,
+    dt_from_last_week_as_string_fxformat,
+    
+    # Trading helpers
+    read_fx_str_from_config,
+    
+    # Helper functions for advanced use
+    update_settings,
+    load_arg_default_from_settings_if_exist,
+)
+
+__version__ = "1.0.0"
+__author__ = "JGWill"
+__description__ = "Core library functions extracted from jgtutils"
+
+# Export the main functions that external packages are likely to use
+__all__ = [
+    # Configuration functions
+    'readconfig',
+    'load_settings', 
+    'get_settings',
+    
+    # Simple API wrappers
+    'get_config',
+    'get_setting',
+    'setup_environment',
+    'get_config_value',
+    'is_demo_mode',
+    
+    # Environment helpers
+    'load_arg_from_jgt_env',
+    'load_arg_default_from_settings',
+    'export_env_if_any',
+    
+    # Utility functions
+    'str_to_datetime',
+    'print_exception',
+    'is_market_open',
+    'dt_from_last_week_as_datetime',
+    'dt_from_last_week_as_string_fxformat',
+    
+    # Trading helpers
+    'read_fx_str_from_config',
+    
+    # Helper functions
+    'update_settings',
+    'load_arg_default_from_settings_if_exist',
+]