Skip to content
Snippets Groups Projects
Commit 359b4d1e authored by David Thomas's avatar David Thomas
Browse files

Initial commit, 2018-05-22 dthomas

parents
No related branches found
No related tags found
No related merge requests found
.. include:: ../HISTORY.rst
Welcome to changeo's documentation!
======================================
.. toctree::
:maxdepth: 2
:caption: Contents:
readme
installation
usage
modules
contributing
authors
history
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. highlight:: shell
============
Installation
============
Stable release
--------------
To install changeo, run this command in your terminal:
.. code-block:: console
$ pip install changeo
This is the preferred method to install changeo, as it will always install the most recent stable release.
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
From sources
------------
The sources for changeo can be downloaded from the `Github repo`_.
You can either clone the public repository:
.. code-block:: console
$ git clone https://git.passcal.nmt.edu/passoft/changeo
Or download the `tarball`_:
.. code-block:: console
$ curl -OL https://git.passcal.nmt.edu/passoft/changeo/tarball/master
Once you have a copy of the source, you can install it with:
.. code-block:: console
$ python setup.py install
.. _Github repo: https://git.passcal.nmt.edu/passoft/changeo
.. _tarball: https://git.passcal.nmt.edu/passoft/changeo/tarball/master
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=changeo
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
.. include:: ../README.rst
=====
Usage
=====
To use changeo in a project::
import changeo
pip==9.0.1
bumpversion==0.5.3
wheel==0.30.0
watchdog==0.8.3
flake8==3.5.0
tox==2.9.1
coverage==4.5.1
Sphinx==1.7.1
twine==1.10.0
[bumpversion]
current_version = 2016.35
commit = True
tag = True
[bumpversion:file:setup.py]
search = version='{current_version}'
replace = version='{new_version}'
[bumpversion:file:changeo/__init__.py]
search = __version__ = '{current_version}'
replace = __version__ = '{new_version}'
[bdist_wheel]
universal = 1
[flake8]
exclude = docs
[aliases]
# Define setup.py command aliases here
setup.py 0 → 100644
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""The setup script."""
from setuptools import setup, find_packages
with open('README.rst') as readme_file:
readme = readme_file.read()
with open('HISTORY.rst') as history_file:
history = history_file.read()
setup(
author="IRIS PASSCAL",
author_email='software-support@passcal.nmt.edu',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Natural Language :: English',
'Programming Language :: Python :: 2.7',
],
description="Used to gang pprogram and test RT130's.",
entry_points={
'console_scripts': [
'changeo=changeo.changeo:main',
],
},
install_requires=[],
setup_requires = [],
license="GNU General Public License v3",
long_description=readme + '\n\n' + history,
include_package_data=True,
keywords='changeo',
name='changeo',
packages=find_packages(include=['changeo']),
test_suite='tests',
url='https://git.passcal.nmt.edu/passoft/changeo',
version='2016.35',
zip_safe=False,
)
# -*- coding: utf-8 -*-
"""Unit test package for changeo."""
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests for `changeo` package."""
import unittest
import sys
try:
import changeo
except ImportError:
pass
class TestChangeo(unittest.TestCase):
"""Tests for `changeo` package."""
def setUp(self):
"""Set up test fixtures, if any."""
def tearDown(self):
"""Tear down test fixtures, if any."""
def test_import(self):
if 'changeo' in sys.modules:
self.assert_(True, "changeo loaded")
else:
self.fail()
tox.ini 0 → 100644
[tox]
envlist = py27, flake8
[travis]
python =
2.7: py27
[testenv:flake8]
basepython = python
deps = flake8
commands = flake8 changeo
[testenv]
setenv =
PYTHONPATH = {toxinidir}
python setup.py test
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment