Skip to content

Latest commit

 

History

History
82 lines (63 loc) · 3.54 KB

README.md

File metadata and controls

82 lines (63 loc) · 3.54 KB
Raw

Taipy Core

Python PyPI

License

Copyright 2023 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

What is Taipy Core

Taipy is a Python library for creating Business Applications. More information on our website. Taipy is split into multiple repositories including taipy-core 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.

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

Installation

Want to install Taipy Core? Check out our INSTALLATION.md file.

Contributing

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

Code of conduct

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

Directory Structure

  • src/:
    • taipy/core/:
      • _manager: Internal package for entity manager.
      • _repository: Internal package for data storage.
      • _orchestrator: Internal package for task orchestrating and execution.
      • _version: Internal package for managing Taipy Core application version.
      • common: Shared data structures, types, and functions.
      • config: Configuration definition, management and implementation.
      • cycle: Work cycle definition, management and implementation.
      • data: Data Node definition, management and implementation.
      • exceptions: taipy-core exceptions.
      • job: Job definition, management and implementation.
      • sequence: Sequence definition, management and implementation.
      • scenario: Scenario definition, management and implementation.
      • task: Task definition, management and implementation.
      • taipy: Main entrypoint for taipy-core runtime features.
  • tests: Unit tests following the taipy/core/ structure.
  • CODE_OF_CONDUCT.md: Code of conduct for members and contributors of taipy-core.
  • CONTRIBUTING.md: Instructions to contribute to taipy-core.
  • INSTALLATION.md: Instructions to install taipy-core.
  • LICENSE: The Apache 2.0 License.
  • Pipfile: File used by the Pipenv virtual environment to manage project dependencies.
  • README.md: Current file.
  • contributors.txt: The list of contributors.
  • setup.py: The setup script managing building, distributing, and installing taipy-core.
  • tox.ini: Contains test scenarios to be run.