Commit d8b2e18b authored by Bruno Morgado's avatar Bruno Morgado Committed by Bruno S. Morgado
Browse files

Updated basic Python project skeleton 



- Added pkg requirements descriptors (requirements.txt, environment.yml)
- Added setup utilities already with some functionality for testing
- Added initial testing structure.
- Modified package directory for naming best practices.
- Minor modifications.

Signed-off-by: default avatarBruno S. Morgado <jb.morgado@gmail.com>
parent 4c840483

.gitignore

+21 −3
Original line number Diff line number Diff line 
*.py[cod]

*.egg-info

*.eggs

.ipynb_checkpoints



build

.DS_Store

*.swp

*~ 
dist

.cache

__pycache__



htmlcov

.coverage

coverage.xml

.pytest_cache



docs/_build

docs/apidocs



# ide

.idea

.eclipse

.vscode

CHANGELOG.rst

0 → 100644
+14 −0
Original line number Diff line number Diff line 
###########

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

LICENSE

+26 −6
Original line number Diff line number Diff line 
Copyright 2018 SKA Organisation



Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

BSD License



1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Copyright (c) 2018, 

All rights reserved.



2. 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.

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

are permitted provided that the following conditions are met:



3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

* 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 Project 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.

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.

environment.yml

0 → 100644
+4 −0
Original line number Diff line number Diff line 
name: ska-skeleton

dependencies:

  - pygments

  - setuptools
 
 No newline at end of file

requirements.txt

0 → 100644
+2 −0
Original line number Diff line number Diff line 
pygments

setuptools
 
 No newline at end of file