- Moved the call to the truncate function to always execute at the beginning of the main function. - Ensured that the feature layer is cleared before loading data from a JSON file or fetching from the API. |
||
|---|---|---|
| .gitignore | ||
| app.py | ||
| LICENSE | ||
| logo.png | ||
| README.md | ||
| requirements.txt | ||
753 Data Sync
A Python-based data ingestion tool for syncing enforcement data from a public API to ArcGIS Online.
🚀 Overview
This script fetches enforcement data from an external API, truncates a specified feature layer in ArcGIS, and adds the fetched data as features to the layer. It also logs the operation, saves data to JSON files, and optionally purges old files. Additionally, it supports reloading data from a JSON file without making API calls.
📦 Requirements
- Python 3.6 or higher
- Required packages in
requirements.txt .envfile with your configuration- ArcGIS Online credentials
🔧 Installation
pip install -r requirements.txt
Or install packages individually:
pip install requests python-dotenv
⚙️ Configuration
Create a .env file in the root of your project:
API_URL=https://example.com/api
AGOL_USER=your_username
AGOL_PASSWORD=your_password
HOSTNAME=www.arcgis.com
INSTANCE=your_instance
FS=your_feature_service
LAYER=0
LOG_LEVEL=DEBUG
PURGE_DAYS=5
Required Variables
| Variable | Description |
|---|---|
API_URL |
The API endpoint to fetch data from |
AGOL_USER |
ArcGIS Online username |
AGOL_PASSWORD |
ArcGIS Online password |
HOSTNAME |
ArcGIS host (e.g., www.arcgis.com) |
INSTANCE |
ArcGIS REST instance path |
FS |
Feature service name |
LAYER |
Feature layer ID or name |
Optional Variables
| Variable | Description |
|---|---|
LOG_LEVEL |
Log level (DEBUG, INFO, etc.) |
PURGE_DAYS |
Number of days to retain logs and JSONs |
🧪 Script Usage
python 753DataSync.py --results_per_page 100
CLI Arguments
| Argument | Description |
|---|---|
--results_per_page |
Optional. Number of results per API call (default: 100) |
--test |
Optional. If set, only fetch the first page of results. |
--reload |
Optional. Load data from a specified JSON file instead of fetching from the API. |
📋 Functionality
- 🔁 Truncate Layer — Clears existing ArcGIS features.
- 🌐 Fetch Data — Retrieves paginated data from the API.
- 💾 Save Data — Writes each page to a time-stamped JSON file.
- 📦 Aggregate Data — Combines all pages into one file.
- 📤 Add Features — Sends data to ArcGIS feature layer.
- 🧹 File Cleanup — Deletes
.json/.logfiles older thanPURGE_DAYS. - 📑 Dynamic Logs — Logs saved to
753DataSync_YYYY-MM-DD.log. - 🧪 Test Mode — Use the
--testflag to fetch only the first page of results for testing purposes. - 🔄 Reload Data — Use the
--reloadflag to truncate the feature layer and load data from a specified JSON file.
📁 Example Output
📁 data/
├── enforcement_page_1_results_100_2025-03-26_14-30-45.json
├── enforcement_page_2_results_100_2025-03-26_14-31-10.json
└── aggregated_enforcement_results_2025-03-26_14-31-15.json
📄 753DataSync_2025-03-26.log
📝 Example Log
2025-03-26 14:30:45 - INFO - Attempting to truncate layer...
2025-03-26 14:30:51 - INFO - Fetching page 1 from API...
2025-03-26 14:30:55 - INFO - Saved data to data/enforcement_page_1_results_100_...
2025-03-26 14:30:57 - INFO - Aggregated data saved.
2025-03-26 14:31:00 - INFO - Features added successfully.
2025-03-26 14:31:01 - INFO - Deleted old log: 753DataSync_2025-03-19.log
🛠 Troubleshooting
- Set
LOG_LEVEL=DEBUGin.envfor detailed logs. - Ensure
.envhas no syntax errors. - Make sure your ArcGIS layer has permission for truncation and writes.
- Check for internet/API access and expired ArcGIS tokens.
- Logs are written to both console and daily log files.
🧪 Testing
Currently, the script is tested manually. Automated testing may be added under a /tests folder in the future.
📖 Usage Examples
# Run with default page size
python 753DataSync.py
# Run with custom page size
python 753DataSync.py --results_per_page 50
💬 Support
Found a bug or want to request a feature?
Open an issue or contact @nick directly.
📜 License
This project is licensed under the GNU General Public License v3.0.
💡 You are free to use, modify, and share this project as long as you preserve the same license in your changes.
