Skip to content

Commit d0cc55c

Browse files
jansigmundjansigmund
committed
Initial commit
1 parent 81d3614 commit d0cc55c

34 files changed

+2580
-2
lines changed

‎.gitignore

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# Distribution / packaging
7+
.Python
8+
build/
9+
develop-eggs/
10+
dist/
11+
downloads/
12+
eggs/
13+
.eggs/
14+
lib/
15+
lib64/
16+
parts/
17+
sdist/
18+
var/
19+
*.egg-info/
20+
.installed.cfg
21+
*.egg
22+
23+
# PyInstaller
24+
# Usually these files are written by a python script from a template
25+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
26+
*.manifest
27+
*.spec
28+
29+
# Installer logs
30+
pip-log.txt
31+
pip-delete-this-directory.txt
32+
33+
# Unit test / coverage reports
34+
htmlcov/
35+
.tox/
36+
.nox/
37+
.coverage
38+
.coverage.*
39+
.cache
40+
nosetests.xml
41+
coverage.xml
42+
*.cover
43+
.hypothesis/
44+
.pytest_cache/
45+
cover/
46+
47+
# Jupyter Notebook
48+
.ipynb_checkpoints
49+
50+
# pyenv
51+
.python-version
52+
53+
# celery beat schedule file
54+
celerybeat-schedule
55+
56+
# SageMath parsed files
57+
*.sage.py
58+
59+
# Environments
60+
.env
61+
.venv
62+
env/
63+
venv/
64+
ENV/
65+
env.bak/
66+
venv.bak/
67+
68+
# Spyder project settings
69+
.spyderproject
70+
.spyproject
71+
72+
# Rope project settings
73+
.ropeproject
74+
75+
# mkdocs documentation
76+
/site
77+
78+
# mypy
79+
.mypy_cache/
80+
.dmypy.json
81+
dmypy.json
82+
83+
# Pyre type checker
84+
.pyre/
85+
86+
# Dev folder
87+
dev/

‎CHANGELOG.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to the `log_hub` project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.1.0] - 2023-12-14
8+
9+
### Added
10+
- Initial release of the `log_hub` Python package.
11+
- Support for several Supply Chain Visualization, Network Design Optimization, and Transport Optimization services.
12+
- Integration capabilities with the Log-hub API.
13+
- Features for Forward and Reverse Geocoding.
14+
- Forward and Reverse Distance Calculation functionalities.
15+
- Network Design Optimization tools including various Center of Gravity models.
16+
- Transport Optimization features including Milkrun Optimization and Transport Optimization Plus.
17+
- Shipment Analyzer for both forward and reverse directions.
18+
- Comprehensive README file for installation, configuration, and usage instructions.
19+
- Sample data and usage examples for key functionalities.
20+
- Support for Python 3.10 and later.
21+
- Virtual environment setup instructions for isolated development.
22+
- MIT License for open and permissive software distribution.
23+
- Secure API key handling for user authentication and data security.
24+
25+
### Fixed
26+
- N/A (initial release).
27+
28+
### Deprecated
29+
- N/A (initial release).
30+
31+
### Removed
32+
- N/A (initial release).
33+
34+
### Security
35+
- Initial implementation of security measures for API communication and data handling.

‎LICENSE

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) [2023] [Log-hub AG]
4+
5+
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:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
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.

‎MANIFEST.in

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include README.md
2+
include CHANGELOG.md

‎README.md

+108-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,108 @@
1-
# log-hub-python
2-
The official Python library for the Log-hub API
1+
2+
# Log-hub Python API library
3+
4+
## Introduction
5+
6+
The `log_hub` package provides convinient access to various Log-hub API services for Supply Chain Visualization, Network Design Optimization, and Transport Optimization.
7+
8+
### Prerequisites
9+
10+
- Python 3.10 or later recommended
11+
- Pip (Python package manager)
12+
- Log-hub API key
13+
- Supply Chain APPS PRO subscription
14+
15+
## Installation
16+
17+
### Setting Up Python Environment
18+
19+
#### Recommended Python Version
20+
21+
Python 3.10 or later is recommended for optimal performance and compatibility.
22+
23+
#### Optional: Setting Up a Virtual Environment
24+
25+
A virtual environment allows you to manage Python packages for different projects separately.
26+
27+
1. **Create a Virtual Environment**:
28+
- **Windows**:
29+
```bash
30+
python -m venv loghub_env
31+
```
32+
- **macOS/Linux**:
33+
```bash
34+
python3 -m venv loghub_env
35+
```
36+
37+
2. **Activate the Virtual Environment**:
38+
- **Windows**:
39+
```bash
40+
.\loghub_env\Scripts\activate
41+
```
42+
- **macOS/Linux**:
43+
```bash
44+
source loghub_env/bin/activate
45+
```
46+
47+
Deactivate with `deactivate` when done.
48+
49+
### Installing `log_hub` Package
50+
51+
Within the environment, install the package using:
52+
53+
```bash
54+
pip install log_hub
55+
```
56+
57+
## Configuration
58+
59+
### Obtaining an API Key
60+
61+
1. Sign up or log in at [Log-hub Account Integration](https://production.supply-chain-apps.log-hub.com/sca/account/integration).
62+
2. Obtain your API key.
63+
64+
### Setting Up Your Environment
65+
66+
Securely store your API key for use in your Python scripts or as an environment variable.
67+
68+
## Usage
69+
70+
### Sample Code: Reverse Distance Calculation
71+
72+
This example demonstrates using the Reverse Distance Calculation feature:
73+
74+
1. **Import Functions**:
75+
```python
76+
from log_hub.distance_calculation import reverse_distance_calculation, reverse_distance_calculation_sample_data
77+
```
78+
79+
2. **Load Sample Data**:
80+
```python
81+
sample_data = reverse_distance_calculation_sample_data()
82+
geocode_data_df = sample_data['geocode_data']
83+
parameters = sample_data['parameters']
84+
```
85+
86+
3. **Perform Calculation**:
87+
```python
88+
reverse_distance_result_df = reverse_distance_calculation(geocode_data_df, parameters, 'YOUR_API_KEY')
89+
```
90+
91+
Replace `'YOUR_API_KEY'` with your actual Log-hub API key.
92+
93+
4. **View Results**:
94+
```python
95+
print(reverse_distance_result_df)
96+
```
97+
98+
## Support
99+
100+
For additional support, questions, or feedback, please reach out to us via email:
101+
102+
- Email Support: [[email protected]](mailto:[email protected])
103+
104+
Alternatively, for more information and resources, visit [Log-hub API Documentation](https://production.supply-chain-apps.log-hub.com/sca/api-docs).
105+
106+
## License
107+
108+
Distributed under the [MIT License](https://opensource.org/licenses/MIT).

‎log_hub/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__version__ = '0.1.0'

0 commit comments

Comments
 (0)