Metadata-Version: 1.2
Name: ufotest
Version: 0.4.1
Summary: CLI for setting up ufo camera test station
Home-page: https://github.com/the16thpythonist/ufotest
Author: Jonas Teufel
Author-email: jonseb1998@gmail.com
License: MIT license
Description: =======
        ufotest
        =======
        
        .. image:: ../logo.png
                :alt: Logo
        
        .. image:: https://img.shields.io/pypi/v/ufotest.svg
                :target: https://pypi.python.org/pypi/ufotest
        
        .. image:: https://img.shields.io/travis/the16thpythonist/ufotest.svg
                :target: https://travis-ci.com/the16thpythonist/ufotest
        
        .. image:: https://readthedocs.org/projects/ufotest/badge/?version=latest
                :target: https://ufotest.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        The ufotest project provides a command line interface to install and test the UFO camera, which was developed at the
        Institute of Data Processing (IPE) of the Karlsruhe Institute of Technology (KIT).
        
        * Free software: MIT license
        * Documentation: https://ufotest.readthedocs.io.
        
        Installation
        ------------
        
        The easiest way to install this package is by using PIP. This will automatically install all the requirements and
        also register the CLI commands to be usable.
        (Note that the "sudo" is important to make the commands register correctly within the operating system)
        
        .. code-block:: console
        
            $ sudo pip3 install ufotest
            $ ufotest init
        
        Usage
        -----
        
        The command line can be accessed through the `ufotest` command within the console. Use the `--help` option to display
        a list of all available commands or consilt the Documentation for a more detailed explanation
        
        .. code-block:: console
        
            $ ufotest --help
        
        Features
        --------
        
        - Global configuration file
        - Automatic installation of all dependencies for a barebones operation of the UFO camera
        
        Credits
        -------
        
        The following software was used in the creation of the project:
        
        * Cookiecutter_: A CLI tool for project templating
        * `audreyr/cookiecutter-pypackage`_: A basic template for python package projects
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-08-13)
        ------------------
        
        - First release on PyPI.
        
        0.2.0 (2020-08-23)
        ------------------
        
        - First actual release with content
            - "install" command to install ufotest command automatically
            - "config" command to edit global configuration file
            - "frame" command to acquire and display a single frame
        
        0.3.0 (2020-08-24)
        ------------------
        
        - Added additional package for SUSE which installs c++ compiler
        - Fixed unhandled exception in "frame"
        - Added additional output if a cmake installation fails
        - fixed readme
        - Added "init" command, which will setup the installation folder and the config file
        
        0.3.1 (2020-08-25)
        ------------------
        
        - Small adjustments to the documentation
        - Added "status.sh" and "reset.sh" scripts from michele to the main code folder.
        
        0.4.0 (2020-08-27)
        ------------------
        
        - Added installation packages for OpenSUSE to the documentation
        - Copied the power up and power down scripts from the IPE
        - Copied the vivado start script from the IPE
        - Now checking for a valid ufotest installation before every command, thus preventing running into an obvious exception.
        - Added jinja2 to the requirements
        - Added module "camera.py" instead of "capture.py" to contain all the camera related functionality
        - Modified config file
            - Added "scripts" section, which allows the user to register custom commands.
        - Added the "script" command: Executes (bash) scripts, which were registered in the project
        - Added functions which setup and teardown the camera state
            - Execute them in "frame" command
        - Added an option to "config" which allows to specify the editor
        
        0.4.1 (2020-08-27)
        ------------------
        
        - Fixed the MANIFEST.in file, which did not include the bash scripts in the distribution package
        
        
        TODO
        ----
        
        - Add the installation of vivado.
            - Can we add the installer to the repository? If not download using curl
        - I could write a "Camera" context manager object...?
        - Make a real help text for the init command
        - Update documentation
            - Add init command
            - (Add frame command)
            - Add script command
            - Add option to define scripts in the config section
        - Setup Sphinx autodoc for this project
        - Make "init" add the necessary stuff to the bashrc file. use jinja2?
        - Figure out how to flash a bit file to the controller programmatically
        
        
Keywords: ufotest
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
