taipy-rest 1.0.1

A 360° open-source platform from Python pilots to production-ready web apps.

Taipy-REST

License

Copyright 2022 Avaiga Private Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Usage

• Taipy-REST
  • License
  • Usage
  • What is Taipy REST
  • Installation
  • Contributing
  • Code of conduct
  • Directory Structure

What is Taipy REST

Taipy is a Python library for creating Business Applications. More information on our website. Taipy is split into multiple repositories including taipy-core and taipy-rest to let users install the minimum they need.

Taipy Core mostly includes business-oriented features. It helps users create and manage business applications and improve analyses capability through time, conditions and hypothesis.

Taipy REST is a set of APIs built on top of the taipy-core library developed by Avaiga. This project is meant to be used as a complement for taipy and its goal is to enable automation through rest APIs of processes built on taipy.

The project comes with rest APIs that provide interaction with all of taipy modules:

• DataNodes
• Tasks
• Jobs
• Pipelines
• Scenarios
• Cycles

A more in depth documentation of taipy can be found here.

Installation

Want to install and try Taipy REST? Check out our INSTALLATION.md file.

Contributing

Want to help build Taipy REST? Check out our CONTRIBUTING.md file.

Code of conduct

Want to be part of the Taipy REST community? Check out our CODE_OF_CONDUCT.md file.

Directory Structure

• src/taipy/rest: Main source code folder.
  • api: Endpoints and schema definitions.
    • resources: Implementation of all endpoints related to taipy.
    • schemas: Schemas related to taipy objects. Used for marshalling and unmarshalling data.
    • views: Mapping of resources to urls
  • commons: Common files shared throughout the application
    • templates: Swagger and redoc templates for generating the documentation
  • app.py: Flask app configuration and creation
  • extensions.py: Singletons used on the application factory
  • rest.py: Main python entrypoint for running taipy-rest application.
• tests: Unit tests.
• CODE_OF_CONDUCT.md: Code of conduct for members and contributors of taipy-rest.
• CONTRIBUTING.md: Instructions to contribute to taipy-rest.
• INSTALLATION.md: Instructions to install taipy-rest.
• LICENSE: The Apache 2.0 License.
• Pipfile: File used by the Pipenv virtual environment to manage project dependencies.
• README.md: Current file.
• setup.py: The setup script managing building, distributing, and installing taipy-rest.
• tox.ini: Contains test scenarios to be run.