Skip to content

Commit ab3bcb0

Browse files
jrichter-svmxjrichter-svmx
committed
Adding readmes
1 parent f743918 commit ab3bcb0

File tree

2 files changed

+151
-0
lines changed

2 files changed

+151
-0
lines changed

‎README.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Python-REST-Client-Examples by DNA-Evolutions
2+
3+
4+
5+
<a href="https://dna-evolutions.com/" target="_blank"><img src="https://docs.dna-evolutions.com/indexres/dna-temp-logo.png" width="110"
6+
title="DNA-Evolutions" alt="DNA-Evolutions"></a>
7+
8+
9+
Containerizing an application helps to use it more conveniently across different platforms and, most importantly, as a microservice. Further, scaling an application becomes more straightforward as various standardized orchestration tools can be utilized. A Microservice can be launched either (locally) or, for example, as a highly-scalable web-micro-service in a Kubernetes cluster.
10+
11+
---
12+
13+
# Further Documentation, Contact and Links
14+
15+
- Further documentation - <a href="https://docs.dna-evolutions.com" target="_blank">docs.dna-evolutions.com</a>
16+
- Special features - <a href="https://docs.dna-evolutions.com/overview_docs/special_features/Special_Features.html" target="_blank">Overview of special features</a>
17+
- Our official repository - <a href="https://public.repo.dna-evolutions.com" target="_blank">public.repo.dna-evolutions.com</a>
18+
- Our official JavaDocs - <a href="https://public.javadoc.dna-evolutions.com" target="_blank">public.javadoc.dna-evolutions.com</a>
19+
- Our YouTube channel - <a href="https://www.youtube.com/channel/UCzfZjJLp5Rrk7U2UKsOf8Fw" target="_blank">DNA Tutorials</a>
20+
- Documentation - <a href="https://docs.dna-evolutions.com/rest/touroptimizer/rest_touroptimizer.html" target="_blank">DNA's RESTful Spring-TourOptimizer in Docker </a>
21+
- Our DockerHub channel - <a href="https://hub.docker.com/u/dnaevolutions" target="_blank">DNA DockerHub</a>
22+
- Our LinkedIn channel - <a href="https://www.linkedin.com/company/dna-evolutions/" target="_blank">DNA LinkedIn</a>
23+
24+
25+
If you need any help, don't hesitate to get in contact with us via our company website <a href="https://www.dna-evolutions.com" target="_blank">www.dna-evolutions.com</a> or write an email to <a href="mailto:info@dna-evolutions.com">info@dna-evolutions.com</a>.
26+
27+
28+
---
29+
30+
31+
# Short Introduction
32+
This repository is part of our JOpt-REST-Suite. It provides examples of how to set up a REST client in Python to access the following DNA Evolution's web services:
33+
34+
- JOpt-TourOptimizer based on JOpt-Core (available as a local Container and via Azure)
35+
36+
The service can be called via an API-Key using our Microsoft Azure-Kubernetes Infrastructure. If you are interested in hosting our JOpt-REST-GeoCoder and JOpt-REST-GeoRouter products in your environment, please get in contact with us.
37+
38+
All our RESTful Services utilize <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html" target="_blank">Spring WebFlux</a> and <a href="https://swagger.io/" target="_blank">Swagger</a>. Internally the Java version of TourOptimizer is used. Indeed all specifications for the different services are derived from the core library, leading to guaranteed compatibility between all three services.
39+
40+
<a href="https://dna-evolutions.com/" target="_blank"><img src="https://docs.dna-evolutions.com/indexres/dna-evolutions-product-infographic-jopt-cloud-integration-highres.svg" width="600"
41+
title="DNA-Evolutions Integration" alt="DNA-Evolutions Integration"></a>
42+
43+
### JOpt-TourOptimizer
44+
Optimize a problem consisting of Nodes, Resources, and optionally externally provided connections. In contrast to our other services, we allow you to host your JOpt-TourOptimizer locally. Please refer to <a href="https://github.com/DNA-Evolutions/Docker-REST-TourOptimizer#how-to-start-jopttouroptimizer-docker" target="_blank">"How to start JOpt TourOptimizer in docker"</a> for more help.
45+
46+
---
47+
48+
# Outline of this repository
49+
50+
Examples</a>
51+
1. <a href="https://github.com/DNA-Evolutions/Python-REST-Client-Examples/tree/master/examples" target="_blank">TourOptimizer Python Examples</a>
52+
53+
Each of the sections has its README.
54+
55+
---
56+
57+
58+
# The architecture of the generated REST-Client-API
59+
60+
The Python-REST-Client class files used by the examples of this repository were generated utilizing the <a href="https://openapi-generator.tech/docs/generators/python/" target="_blank">openapi-python Generator</a> by <a href="https://github.com/OpenAPITools" target="_blank">OpenAPI Tools</a>.
61+
62+
For creating the models, we used the containerized version of Open-API-Generator by calling:
63+
64+
```xml
65+
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:latest generate -i '/local/swagger/touroptimizer/spec/touroptimizer_spec.json' -g python -o /local/generated/jopt-touroptimizer-py-client --package-name=touroptimizer_py_client --additional-properties="useOneOfDiscriminatorLookup=true"
66+
67+
```
68+
69+
where `${PWD}` needs to be adjusted to find the Open-API-docs under `/local/swagger/touroptimizer/spec/touroptimizer_spec.json` when mounting the volume `${PWD}` into `/local`. Calling the command will generate the Python client that is part of this repository. You can find the `touroptimizer_spec.json` <a href="https://github.com/DNA-Evolutions/Java-REST-Client-Examples/blob/master/src/main/resources/swagger/touroptimizer/spec/touroptimizer_spec.json" target="_blank">here</a>.
70+
71+
**Attention:** The generated models seem to have some bugs. The first commit of this repository is fixing those issues.
72+
73+
You can also generate a client in the programming language of your choice utilizing our API-docs. REST facilitates software integration in your desired language (including famous ones like C#, Java, JS, Scala, Python, and many more ). Don't hesitate to reach out to us if you need help setting up your client.
74+
75+
76+
For setting up a local test enviorment with database support, please refer to the separate **Hands-on Tutorial: Setting Up a Local Fire and Forget TourOptimizer-Database Test Environment** [tutorial](https://github.com/DNA-Evolutions/Docker-REST-TourOptimizer/blob/main/TourOptimizerWithDatabase.md).
77+
78+
---
79+
80+
# Getting started
81+
82+
You can start using our examples:
83+
84+
* [Clone this repository](#clone-this-repository)
85+
86+
87+
## Prerequisites
88+
89+
* Python installed
90+
* Please check **requirements.txt**
91+
* Working Docker environment for local TourOptimizer instance
92+
93+
94+
## Clone this repository
95+
Clone this repository and import it in your favourite IDE.
96+
97+
98+
## Install necessary files
99+
You can call (from the main folder):
100+
101+
```bash
102+
python setup.py install
103+
```
104+
105+
## Run the examples
106+
107+
Run a file from the **examples** subfolders.
108+
109+
110+
## Why use JOpt products from DNA Evolutions?
111+
JOpt is a flexible routing optimization engine written in Java, allowing to solve tour-optimization problems that are highly restricted. For example, regarding time windows, skills, and even mandatory constraints can be applied.
112+
113+
Click to open our video:
114+
115+
<a href="https://www.youtube.com/watch?v=U4mDQGnZGZs" target="_blank"><img src="https://dna-evolutions.com/wp-content/uploads/2021/02/joptIntrox169_small.png" width="500"
116+
title="Introduction Video for DNA's JOpt" alt="Introduction Video for DNA's JOpt"></a>
117+
118+
---
119+
120+
## Agreement
121+
For reading our license agreement and for further information about license plans, please visit <a href="https://www.dna-evolutions.com" target="_blank">www.dna-evolutions.com</a>.
122+
123+
---
124+
125+
## Authors
126+
A product by [dna-evolutions ](https://www.dna-evolutions.com)&copy;

‎examples/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Python Examples
2+
3+
Python Examples are a collection of examples of using the JOpt TourOptimizer suite. The examples are utilizing the Python Client project.
4+
5+
## The Architecture
6+
The utils project is subdivided into different parts:
7+
8+
9+
### TourOptimizer
10+
Examples dealing with the use of DNA's JOpt containerized TourOptimizer, either via Azure as a service or a local docker instance. Please refer to <a href="https://github.com/DNA-Evolutions/Docker-REST-TourOptimizer#how-to-start-jopttouroptimizer-docker" target="_blank">How to start JOpt TourOptimizer in docker</a> for more help.
11+
12+
13+
**1. health\tour_optimizer_health_example.py:** Basic example on how to call the JOpt TourOptimizer service health status.
14+
15+
**2a. loadFAF\tour_optimizer_load_faf_example.py:** Guides how to load an optimization from a database
16+
**2b. loadFAF\tour_optimizer_load_encrypted_faf_example.py:** Guides how to load an encrypted optimization from a database
17+
18+
**3. optimize\tour_optimizer_example.py:** Basic example on how to call the JOpt TourOptimizer service
19+
20+
**4. optimizeFAF\tour_optimizer_faf_example.py:** Demonstrates how to run an optimization and save it to the database
21+
22+
**5. searchFAF\tour_optimizer_search_faf_example.py:** Shows how to search optimizations within a database and display their meta info
23+
24+
25+
For setting up a local test enviorment with database support, please refer to the separate **Hands-on Tutorial: Setting Up a Local Fire and Forget TourOptimizer-Database Test Environment** [tutorial](https://github.com/DNA-Evolutions/Docker-REST-TourOptimizer/blob/main/TourOptimizerWithDatabase.md).

0 commit comments

Comments
 (0)