You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,9 @@ The ontological framework is composed of four main modules:
21
21
-**ExternalCode Ontology Module:** This module has all the technical details to connect to an external code, it also adds the possibility to dynamically require python packages.
22
22
-**Communications Ontology Module:** This module describes the communication technologies that can be used to fetch the data of some metadata in multiple forms (e. g).
23
23
24
+
> A full manual on how to extend your own ontologies using the OntologyToAPI framework is still in development, but you can check the examples provided at the samples repository to get started at https://github.com/JCGCosta/OntologyToAPISamples
25
+
26
+
24
27
> From now on you must be ready to go and create your own ontological specification importing the [Ontology Modules](https://github.com/JCGCosta/OntologyToAPI/tree/master/OntologicalFramework) and extending it. You can do this by using the Protégé ontology editor (https://protege.stanford.edu/). Or if you prefer you can use any text editor to create your ontology files in the supported formats (.ttl, .rdf, .owl).
25
28
26
29
### Step 1: Installing the Package
@@ -31,7 +34,6 @@ pip install -U ontologytoapi
31
34
32
35
### Step 2: Running
33
36
34
-
- If you want to do a quick test we provided some .ttl samples at the following repository: https://github.com/JCGCosta/OntologyToAPISamples
35
37
- With your metadata and business models ontologies implemented you can generate your API by having the following python file as an entry point:
36
38
37
39
```python
@@ -50,3 +52,25 @@ if __name__ == "__main__":
50
52
api_app = APIGen.generate_api_routes()
51
53
uvicorn.run(api_app, host="127.0.0.1", port=5000)
52
54
```
55
+
56
+
## Supported communication technologies are (Currently):
57
+
58
+
#### Stateful Connections
59
+
- "SOCKET" - For Socket connections using asyncio streams
60
+
61
+
#### Stateless Connections
62
+
- "API" - For REST APIs using requests driver
63
+
- "MYSQL" - For MySQL Databases using aiomysql driver
64
+
- "SQLITE" - For SQLite Databases using aiosqlite driver
65
+
- "POSTGRESQL" - For PostgreSQL Databases using asyncpg driver
66
+
- "MONGODB" - For MongoDB Databases using motor driver
67
+
- "UNQLITE" - For UnQLite Databases using unqlite+asyncio driver
68
+
69
+
## Next Steps:
70
+
71
+
Next steps involve extending the support for new communication technologies.
72
+
- "FILE" - For File operations using aiofiles driver
73
+
- "WEBSOCKET" - For WebSocket connections using websockets driver
74
+
- "MQTT" - For MQTT connections using asyncio-mqtt driver
75
+
- "REDIS" - For Redis Databases using aioredis driver
76
+
- "CASSANDRA" - For Cassandra Databases using cassandra-driver with asyncio support
0 commit comments