Skip to content

Commit

Permalink
fix(pypi): Add readme to pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
DrewLazzeriKitware committed Nov 16, 2021
1 parent 51806be commit b497077
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 17 deletions.
57 changes: 57 additions & 0 deletions docs/api/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,61 @@ All classes are listed in the :ref:`genindex`.
trame.layouts


trame: simple, powerful, innovative
===================================

**trame** - a web framework that weaves together open source components into customized visual analytics easily.

**trame** is French for

* the core that ties things together
* a guide providing the essence of a task

.. image:: https://kitware.github.io/trame/examples/MultiFilter.jpg
:alt: Welcome to trame and 3D visualization

With **trame**, create stunning, interactive web applications compactly and intuitively.

.. image:: https://kitware.github.io/trame/examples/CarotidFlow.jpg
:width: 30%
.. image:: https://kitware.github.io/trame/examples/UberPickupsNYC.jpg
:width: 30%
.. image:: https://kitware.github.io/trame/examples/FiniteElementAnalysis.jpg
:width: 30%

3D Visualization
----------------

VTK and ParaView are first-class citizens at the core of **trame**, providing complete control of 3D visualizations and data movement. The developers enjoy a write-once environment while trame simply exposes both local and remote rendering through a single method.

With best-in-class VTK and ParaView platforms at its core, **trame** provides complete control of 3D visualizations and data movements.
Developers benefit from a write-once environment while **trame** simply exposes both local and remote rendering through a single method.

Rich Features
-------------

**trame** leverages existing libraries and tools such as Vuetify, Altair, Vega, deck.gl, VTK, ParaView, and more, to create vivid content for visual analytics applications.

Problem Focused
---------------

By relying simply on Python and HTML, **trame** focuses on one's data and associated analysis and visualizations while hiding the complications of web development.

Desktop to cloud
----------------

The resulting **trame** applications act as local desktop applications or remote cloud applications both accessed through the browser.

Community
---------

* `WebSite <https://kitware.github.io/trame/>`_
* `Discussions <https://github.com/Kitware/trame/discussions>`_
* `Issues <https://github.com/Kitware/trame/issues>`_
* `RoadMap <https://github.com/Kitware/trame/projects/1>`_
* `Contact Us <https://www.kitware.com/contact-us/>`_

Enjoying trame?
_______________

Share your experience `with a testimonial <https://github.com/Kitware/trame/issues/18>`_ or `with a brand approval <https://github.com/Kitware/trame/issues/19>`_.
58 changes: 58 additions & 0 deletions pypi_readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
trame: simple, powerful, innovative
===================================

**trame** - a web framework that weaves together open source components into customized visual analytics easily.

**trame** is French for

* the core that ties things together
* a guide providing the essence of a task

.. image:: https://kitware.github.io/trame/examples/MultiFilter.jpg
:alt: Welcome to trame and 3D visualization

With **trame**, create stunning, interactive web applications compactly and intuitively.

.. image:: https://kitware.github.io/trame/examples/CarotidFlow.jpg
:width: 30%
.. image:: https://kitware.github.io/trame/examples/UberPickupsNYC.jpg
:width: 30%
.. image:: https://kitware.github.io/trame/examples/FiniteElementAnalysis.jpg
:width: 30%

3D Visualization
----------------

VTK and ParaView are first-class citizens at the core of **trame**, providing complete control of 3D visualizations and data movement. The developers enjoy a write-once environment while trame simply exposes both local and remote rendering through a single method.

With best-in-class VTK and ParaView platforms at its core, **trame** provides complete control of 3D visualizations and data movements.
Developers benefit from a write-once environment while **trame** simply exposes both local and remote rendering through a single method.

Rich Features
-------------

**trame** leverages existing libraries and tools such as Vuetify, Altair, Vega, deck.gl, VTK, ParaView, and more, to create vivid content for visual analytics applications.

Problem Focused
---------------

By relying simply on Python and HTML, **trame** focuses on one's data and associated analysis and visualizations while hiding the complications of web development.

Desktop to cloud
----------------

The resulting **trame** applications act as local desktop applications or remote cloud applications both accessed through the browser.

Community
---------

* `WebSite <https://kitware.github.io/trame/>`_
* `Discussions <https://github.com/Kitware/trame/discussions>`_
* `Issues <https://github.com/Kitware/trame/issues>`_
* `RoadMap <https://github.com/Kitware/trame/projects/1>`_
* `Contact Us <https://www.kitware.com/contact-us/>`_

Enjoying trame?
_______________

Share your experience `with a testimonial <https://github.com/Kitware/trame/issues/18>`_ or `with a brand approval <https://github.com/Kitware/trame/issues/19>`_.
18 changes: 1 addition & 17 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,7 @@
name = trame
version = dev
description = Framework for building interactive Web applications quickly in plain Python
long_description =
simple, powerful, innovative
trame - a web framework that weaves together open source components into customized visual analytics easily.
trame is French for
- the core that ties things together
- a guide providing the essence of a task
With trame, create stunning, interactive web applications compactly and intuitively.
## 3D Visualization
VTK and ParaView are first-class citizens at the core of **trame**, providing complete control of 3D visualizations and data movement. The developers enjoy a write-once environment while trame simply exposes both local and remote rendering through a single method.
With best-in-class VTK and ParaView platforms at its core, **trame** provides complete control of 3D visualizations and data movements.
Developers benefit from a write-once environment while **trame** simply exposes both local and remote rendering through a single method.
## Rich Features
trame leverages existing libraries and tools such as Vuetify, Altair, Vega, deck.gl, VTK, ParaView, and more, to create vivid content for visual analytics applications.
## Problem Focused
By relying simply on Python and HTML, trame focuses on one's data and associated analysis and visualizations while hiding the complications of web development.
## Desktop to cloud
The resulting trame applications act as local desktop applications or remote cloud applications both accessed through the browser.
long_description = file: pypi_readme.rst
author = Kitware, Inc.
author_email = [email protected]
url = https://github.com/kitware/trame
Expand Down

0 comments on commit b497077

Please sign in to comment.