Added an initial project structure.
This commit is contained in:
commit
4e21c0efb0
5 changed files with 94 additions and 0 deletions
6
CARA/__init__.py
Normal file
6
CARA/__init__.py
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
"""
|
||||
Documentation for the CARA package
|
||||
|
||||
"""
|
||||
|
||||
__version__ = "0.0.1.dev0"
|
||||
0
CARA/tests/__init__.py
Normal file
0
CARA/tests/__init__.py
Normal file
10
CARA/tests/test_CARA.py
Normal file
10
CARA/tests/test_CARA.py
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
"""
|
||||
High-level tests for the package.
|
||||
|
||||
"""
|
||||
|
||||
import CARA
|
||||
|
||||
|
||||
def test_version():
|
||||
assert CARA.__version__ is not None
|
||||
18
README.md
Normal file
18
README.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# CARA - COVID Airborne Risk Assessment
|
||||
|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
## Development guide
|
||||
|
||||
### Setting up the application
|
||||
|
||||
The https://cern.ch/cara application is running on CERN's OpenShift platform. In order to set it up for the first time, we followed the documentation at https://cern.service-now.com/service-portal?id=kb_article&n=KB0004498. In particular we:
|
||||
|
||||
* Added the OpenShift application deploy key to the GitLab repository
|
||||
* Created a Python 3.6 (the highest possible at the time of writing) application in OpenShift
|
||||
* Configured a generic webhook on OpenShift, and call that from the CI of the GitLab repository
|
||||
|
||||
|
||||
60
setup.py
Normal file
60
setup.py
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
"""
|
||||
setup.py for CARA.
|
||||
|
||||
For reference see
|
||||
https://packaging.python.org/guides/distributing-packages-using-setuptools/
|
||||
|
||||
"""
|
||||
from pathlib import Path
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
|
||||
HERE = Path(__file__).parent.absolute()
|
||||
with (HERE / 'README.md').open('rt') as fh:
|
||||
LONG_DESCRIPTION = fh.read().strip()
|
||||
|
||||
|
||||
REQUIREMENTS: dict = {
|
||||
'core': [
|
||||
# 'mandatory-requirement1',
|
||||
# 'mandatory-requirement2',
|
||||
],
|
||||
'test': [
|
||||
'pytest',
|
||||
],
|
||||
'dev': [
|
||||
# 'requirement-for-development-purposes-only',
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
setup(
|
||||
name='CARA',
|
||||
version="0.0.1.dev0",
|
||||
|
||||
maintainer='Andre Henriques',
|
||||
maintainer_email='andre.henriques@cern.ch',
|
||||
description='COVID Airborne Risk Assessment',
|
||||
long_description=LONG_DESCRIPTION,
|
||||
long_description_content_type='text/markdown',
|
||||
url='cern.ch/cara',
|
||||
|
||||
packages=find_packages(),
|
||||
python_requires='~=3.6',
|
||||
classifiers=[
|
||||
"Programming Language :: Python :: 3",
|
||||
"Operating System :: OS Independent",
|
||||
],
|
||||
|
||||
install_requires=REQUIREMENTS['core'],
|
||||
extras_require={
|
||||
**REQUIREMENTS,
|
||||
# The 'dev' extra is the union of 'test' and 'doc', with an option
|
||||
# to have explicit development dependencies listed.
|
||||
'dev': [req
|
||||
for extra in ['dev', 'test', 'doc']
|
||||
for req in REQUIREMENTS.get(extra, [])],
|
||||
# The 'all' extra is the union of all requirements.
|
||||
'all': [req for reqs in REQUIREMENTS.values() for req in reqs],
|
||||
},
|
||||
)
|
||||
Loading…
Reference in a new issue