Initial commit

*.py[cod]

*.egg-info

*.eggs

.ipynb_checkpoints

build

dist

.cache

__pycache__

Pipfile.lock

htmlcov

.coverage

coverage.xml

.pytest_cache

*,cover

docs/_build

docs/apidocs

# ide

.idea

.eclipse

.vscode

###########

Change Log

###########

All notable changes to this project will be documented in this file.

This project adheres to `Semantic Versioning <http://semver.org/>`_.

[Unreleased]

************

Added

-----

* Empty Python project directory structure

BSD License

Copyright (c) 2018, SKA Organisation

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,

are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this

  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this

  list of conditions and the following disclaimer in the documentation and/or

  other materials provided with the distribution.

* Neither the name of SKA Skeleton nor the names of its

  contributors may be used to endorse or promote products derived from this

  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

OF THE POSSIBILITY OF SUCH DAMAGE.

[[source]]

url = "https://nexus.engageska-portugal.pt/repository/pypi-proxy/simple"

verify_ssl = true

name = "nexus-proxy"

[[source]]

url = "https://nexus.engageska-portugal.pt/repository/pypi/simple"

verify_ssl = true

name = "nexus-hosted"

[packages]

docutils = "*"

MarkupSafe = "*"

Pygments = "*"

pylint = "*"

pylint-junit = "*"

pytest = "*"

pytest-cov = "*"

pytest-pylint = "*"

pytest-json-report = "*"

python-dotenv = ">=0.5.1"

Sphinx = "*"

sphinx_rtd_theme = "*"

sphinx-autobuild = "*"

sphinxcontrib-websupport = "*"

recommonmark = "*"

[dev-packages]

[requires]

python_version = "3"

SKA Python Skeleton Project

===========================

[![Documentation Status](https://readthedocs.org/projects/ska-python-skeleton/badge/?version=latest)](https://developer.skatelescope.org/projects/skeleton/en/latest/?badge=latest)

Briefly describe your project here

Requirements

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

The system used for development needs to have Python 3 and `pip` installed.

Install 

-------

**Always** use a virtual environment. [Pipenv](https://pipenv.readthedocs.io/en/latest/) is now Python's officially

recommended method and the one used by default in this repo.

Follow these steps at the project root:

First, ensure that `~/.local/bin` is in your `PATH` with:

```bash

> echo $PATH

```

In case `~/.local/bin` is not part of your `PATH` variable, under Linux add it with:

```bash

> export PATH=~/.local/bin:$PATH

```

or the equivalent in your particular OS.

Then proceed to install pipenv and the required environment packages:

```bash

> pip install pipenv # if you don't have pipenv already installed on your system

> pipenv install

> pipenv shell

```

You will now be inside a pipenv shell with your virtual environment ready.

Use `exit` to exit the pipenv environment.

Testing

-------

* Put tests into the `tests` folder

* Use [PyTest](https://pytest.org) as the testing framework

  - Reference: [PyTest introduction](http://pythontesting.net/framework/pytest/pytest-introduction/)

* Run tests with `python setup.py test`

  - Configure PyTest in `setup.py` and `setup.cfg`

* Running the test creates the `htmlcov` folder

    - Inside this folder a rundown of the issues found will be accessible using the `index.html` file

* All the tests should pass before merging the code 

 Code analysis

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

 * Use [Pylint](https://www.pylint.org) as the code analysis framework

 * By default it uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/)

 * Use the provided `code-analysis.sh` script in order to run the code analysis in the `module` and `tests`

 * Code analysis should be run by calling `pylint ska_python_skeleton`. All pertaining options reside under the `.pylintrc` file.

 * Code analysis should only raise document related warnings (i.e. `#FIXME` comments) before merging the code

Writing documentation

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

 * The documentation generator for this project is derived from SKA's [SKA Developer Portal repository](https://github.com/ska-telescope/developer.skatelescope.org)

 * The documentation can be edited under `./docs/src`

 * If you want to include only your README.md file, create a symbolic link inside the `./docs/src` directory if the existing one does not work:

 ```bash

$ cd docs/src

$ ln -s ../../README.md README.md

```

 * In order to build the documentation for this specific project, execute the following under `./docs`:

 ```bash

$ make html

```

* The documentation can then be consulted by opening the file `./docs/build/html/index.html`