Skip to content
Snippets Groups Projects
Commit e39b66ab authored by Davide Gamba's avatar Davide Gamba
Browse files

Initialised repo

parents
No related branches found
No related tags found
No related merge requests found
Pipeline #2574147 passed
# Use the acc-py-devtools templates found at
# https://gitlab.cern.ch/-/ide/project/acc-co/devops/python/acc-py-devtools/blob/master/-/acc_py_devtools/templates/gitlab-ci/python.yml.
include:
- project: acc-co/devops/python/acc-py-devtools
file: acc_py_devtools/templates/gitlab-ci/python.yml
variables:
project_name: datascout
PY_VERSION: '3.7'
# A full installation of datascout, tested with pytest.
test_install:
extends: .acc_py_full_test
# A development installation of datascout tested with pytest.
test_dev:
extends: .acc_py_dev_test
# A push of the source distribution to the acc-py PyPI, only on git tag.
release_sdist_on_tag:
extends: .acc_py_release_sdist
# datascout
Simple package to handle data saving and reading with minimum required libraries.
Mainly used as dependance of pyjapcscout, but it can be used for other purposes as well.
## Purpose of this project
The idea is to provide a few sweet functions go from a nested dict of numpy arrays to parquet (and to pickle, and json) and come back.
## Getting started
## How to develop it:
I set up this package as:
1. create the project on gitlab (https://gitlab.cern.ch/abpcomputing/sandbox/datascout)
2. cloned it on my CERN virtual machine with access to acc-py, so:
```
git clone https://:@gitlab.cern.ch:8443/abpcomputing/sandbox/datascout.git datascout
source /acc/local/share/python/acc-py/base/pro/setup.sh
acc-py init
acc-py init-ci
```
3. filled / added my functions and tests
4. used it in some virtual environment as
```
python -m pip install -e .
```
"""
Documentation for the datascout package
"""
__version__ = "0.0.1.dev0"
"""
High-level tests for the package.
"""
import datascout
def test_version():
assert datascout.__version__ is not None
setup.py 0 → 100644
"""
setup.py for datascout.
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',
],
'doc': [
'sphinx',
'acc-py-sphinx',
],
}
setup(
name='datascout',
version="0.0.1.dev0",
author='Davide Gamba',
author_email='davide.gamba@cern.ch',
description='SHORT DESCRIPTION OF PROJECT',
long_description=LONG_DESCRIPTION,
long_description_content_type='text/markdown',
url='',
packages=find_packages(),
python_requires='~=3.7',
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],
},
)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment