FX Shared Models
A Django package containing shared models and configurations for the FX Backend system. This package provides base models for customers and system settings that can be extended using proxy models in your Django applications.
Features
-
Customer Models
- Base customer model with essential fields
- Customer settings and details
- Customer authentication
- Flexible proxy model support
-
System Settings Models
- Email configuration management
- System-wide settings
- Extensible settings framework
Installation
You can install the package using pip:
pip install fx-shared-models
For development, you can install from source:
git clone https://github.com/yourusername/fx-shared-models.git
cd fx-shared-models
pip install -e .
Quick Start
- Add the shared models to your
INSTALLED_APPSinsettings.py:
INSTALLED_APPS = [
...
'shared_models.customers.apps.CustomersConfig', # Base models
'shared_models.system_settings.apps.SystemSettingsConfig', # Base system settings
...
]
- Create proxy models in your app:
# your_app/models.py
from shared_models.customers.models import Customer as BaseCustomer
class Customer(BaseCustomer):
class Meta:
proxy = True
# Add your custom methods here
Usage Examples
Customer Models
# Using base customer model
from shared_models.customers.models import Customer
# Create a new customer
customer = Customer.objects.create(
email='customer@example.com',
first_name='John',
last_name='Doe'
)
# Using proxy model in your app
from your_app.models import Customer
# Your custom methods will be available
customer = Customer.objects.create_customer(
email='customer@example.com',
first_name='John',
last_name='Doe'
)
System Settings
from shared_models.system_settings.models import EmailConfiguration
# Create email configuration
email_config = EmailConfiguration.objects.create(
name='SMTP Config',
provider='smtp',
from_email='noreply@example.com'
)
Model Structure
Customer Models
Customer: Base customer model with essential fields- Personal information (name, email, phone)
- Status fields (is_funded, is_client, is_ib)
- KYC status tracking
- IB relationship management
System Settings Models
-
SystemSetting: Base settings model- Configuration management
- Status tracking
- Metadata storage
-
EmailConfiguration: Email provider settings- SMTP configuration
- Provider management
- Email templates
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Requirements
- Python >= 3.8
- Django >= 3.0
- django-environ >= 0.10.0
Support
For support, please open an issue in the GitHub repository or contact the development team.
1 maintainer
Metadata
1 maintainer
Release files for fx-shared-models 0.2.99
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fx_shared_models-0.2.99.tar.gz | 225.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fx_shared_models-0.2.99-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 601.2 kB
