Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #16 - Prepare to publish AIT GUI to Pypi #36

Merged
merged 1 commit into from
May 3, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions README.md

This file was deleted.

49 changes: 49 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
AMMOS Instrument Toolkit (AIT) GUI
==================================

AIT GUI provides a framework for building a custom website for realtime
telemetry monitoring, commanding, and other MOS operations with only
minimal HTML and configuration file changes. Built on top of the AIT
Core libraries, AIT GUI provides web-development friendly access to the
underlying telemetry, commanding, EVR, system logging, and other AIT
Core functions in addition to a suite of pre-built UI Components and a
REST API to handle common MOS use cases.

Getting Started
---------------

You can read through the `Installation
Page <http://ait-gui.readthedocs.io/en/latest/installation.html>`__ for
instruction on how to install AIT GUI.

Contributing
------------

For information on how to contribute please see the `AIT GUI
Contributors
Guides <http://ait-gui.readthedocs.io/en/latest/contribute.html>`__

Browser Requirements
--------------------

AIT GUI requires one of the following browsers:

- Firefox version 52.0 or newer
- Chrome version 57.0 or newer

Safari v10.1 or newer will likely work as well but compatibility is not
regularly checked or guaranteed.

--------------

|travis|
|docs|

.. |travis| image:: https://travis-ci.org/NASA-AMMOS/AIT-GUI.svg?branch=master
:alt: build status
:scale: 100%
:target: https://travis-ci.org/NASA-AMMOS/AIT-GUI
.. |docs| image:: https://readthedocs.org/projects/ait-gui/badge/?version=master
:alt: Documentation Status
:scale: 100%
:target: https://ait-gui.readthedocs.io/en/latest/?badge=master
15 changes: 14 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,18 @@
from setuptools.command.install import install
from setuptools.command.develop import develop

import io
import os
import subprocess

description = "A framework for building a custom website for realtime telemetry monitoring, commanding, and other MOS " \
"operations, built atop the AIT Core libraries."

# Get the long description from the README file
here = os.path.abspath(os.path.dirname(__file__))
with io.open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

def install_ui_deps():
try:
FNULL = open(os.devnull, 'wb')
Expand Down Expand Up @@ -77,8 +86,12 @@ def run(self):
setup(
name = 'bliss-gui',
version = '0.24.0',
description = description,
long_description = long_description,
long_description_content_type = 'text/x-rst',
url = 'https://github.com/NASA-AMMOS/AIT-GUI',
packages = find_packages(exclude=['tests']),
author = 'BLISS-Core Development Team',
author = 'AMMOS Instrument Toolkit Development Team',
author_email = '[email protected]',

namespace_packages = ['bliss'],
Expand Down