Skip to content

Commit 30d75af

Browse files
authored
Update README.md
1 parent adc31bc commit 30d75af

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,94 @@
1+
# 📦 csv-db-bridge
2+
3+
[![Build Status](https://github.com/SSobol77/csv-db-bridge/actions/workflows/test.yml/badge.svg)](https://github.com/SSobol77/csv-db-bridge/actions)
4+
[![Python Versions](https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue.svg)](https://www.python.org/)
5+
6+
**csv-db-bridge** is a universal, cross-database toolkit written in Python to import and export data between `.csv` files and the most popular relational and non-relational databases.
7+
8+
Supported operations:
9+
- 📥 Import from CSV/CLI to database
10+
- 📤 Export from database to CSV
11+
12+
Supported databases:
13+
- PostgreSQL
14+
- MySQL
15+
- SQLite3
16+
- Oracle
17+
- AuroraDB (AWS RDS Data API)
18+
- IBM DB2
19+
- MongoDB
20+
21+
---
22+
23+
## 🚀 Features
24+
25+
- Consistent import/export structure
26+
- Modular scripts for each database
27+
- Example scripts and unit tests
28+
- CI/CD via GitHub Actions
29+
- FreeBSD support via Cirrus CI
30+
31+
---
32+
33+
## 📁 Project Structure
34+
35+
```
36+
csv-db-bridge/
37+
├── import/ # CSV ➔ DB (write)
38+
├── export/ # DB ➔ CSV (read)
39+
├── examples/ # Usage examples
40+
├── tests/ # Unit tests with mocks
41+
├── docs/ # Architecture documentation
42+
├── .github/workflows/ # GitHub Actions (CI)
43+
├── .cirrus.yml # FreeBSD CI with Cirrus
44+
├── README.md # You are here
45+
└── LICENSE # GPL-3.0 License
46+
```
47+
48+
---
49+
50+
## 🛠 Requirements
51+
52+
- Python 3.11–3.13
53+
- pip packages:
54+
- `psycopg2-binary`, `mysql-connector-python`, `sqlite3`, `cx_Oracle`
55+
- `pymongo`, `boto3`, `ibm-db`
56+
57+
Install all:
58+
59+
```bash
60+
pip install -r requirements.txt
61+
```
62+
63+
---
64+
65+
## 💪 Run Tests
66+
67+
GitHub Actions will automatically test all files.
68+
To run tests locally:
69+
70+
```bash
71+
python -m unittest discover -s tests -p 'test_*.py'
72+
```
73+
74+
---
75+
76+
## 📄 License
77+
78+
Licensed under **GNU GPL v3.0**
79+
See [LICENSE](LICENSE) for details.
80+
81+
---
82+
83+
## 👤 Author
84+
85+
**Siergej Sobolewski**
86+
📧 [s.sobolewski@hotmail.com](mailto:s.sobolewski@hotmail.com)
87+
🔗 GitHub: [SSobol77](https://github.com/SSobol77)
88+
89+
---
90+
91+
> A solid bridge between your databases and your CSV files.
92+
193
# Data-import-export-CSV---DataBase
294
Block data import and export between .csv format and the most popular databases DB2, Oracle, AuroraDB, MongoDB, PostgreSQL, MySQL, SQLite3

0 commit comments

Comments
 (0)