scrappi 0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2 @@
1
+ include versioneer.py
2
+ include scrappi/_version.py
scrappi-0.0/PKG-INFO ADDED
@@ -0,0 +1,70 @@
1
+ Metadata-Version: 2.1
2
+ Name: scrappi
3
+ Version: 0.0
4
+ Summary: EO Satellite product catalogue retrieval by API or file system
5
+ Home-page: https://gitlab.npl.co.uk/eco/tools/scrappi
6
+ Author: Sam Hunt
7
+ Author-email: sam.hunt@npl.co.uk
8
+ License: None
9
+ Classifier: Development Status :: 2 - Pre-Alpha
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.6
12
+ Classifier: Programming Language :: Python :: 3.7
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Provides-Extra: dev
15
+ Requires-Dist: pre-commit; extra == "dev"
16
+ Requires-Dist: tox; extra == "dev"
17
+ Requires-Dist: sphinx; extra == "dev"
18
+ Requires-Dist: sphinx_rtd_theme; extra == "dev"
19
+
20
+ scrappi
21
+ =======
22
+
23
+ EO Satellite product catalogue retrieval by API or file system
24
+
25
+ Usage
26
+ =====
27
+
28
+ Virtual environment
29
+ -------------------
30
+
31
+ It's always recommended to make a virtual environment for each of your python
32
+ projects. Use your preferred virtual environment manager if you want and
33
+ activate it for the rest of these commands. If you're unfamiliar, read
34
+ https://realpython.com/python-virtual-environments-a-primer/. You can set one up
35
+ using::
36
+
37
+ python -m venv venv
38
+
39
+ and then activate it on Windows by using ``venv/Scripts/activate``.
40
+
41
+ Installation
42
+ ------------
43
+
44
+ Install your package and its dependancies by using::
45
+
46
+ pip install -e .
47
+
48
+ Development
49
+ -----------
50
+
51
+ For developing the package, you'll want to install the pre-commit hooks as well. Type::
52
+
53
+ pre-commit install
54
+
55
+
56
+ Note that from now on when you commit, `black` will check your code for styling
57
+ errors. If it finds any it will correct them, but the commit will be aborted.
58
+ This is so that you can check its work before you continue. If you're happy,
59
+ just commit again.
60
+
61
+ Compatibility
62
+ -------------
63
+
64
+ Licence
65
+ -------
66
+
67
+ Authors
68
+ -------
69
+
70
+ `scrappi` was written by `Sam Hunt <sam.hunt@npl.co.uk>`_.
scrappi-0.0/README.rst ADDED
@@ -0,0 +1,51 @@
1
+ scrappi
2
+ =======
3
+
4
+ EO Satellite product catalogue retrieval by API or file system
5
+
6
+ Usage
7
+ =====
8
+
9
+ Virtual environment
10
+ -------------------
11
+
12
+ It's always recommended to make a virtual environment for each of your python
13
+ projects. Use your preferred virtual environment manager if you want and
14
+ activate it for the rest of these commands. If you're unfamiliar, read
15
+ https://realpython.com/python-virtual-environments-a-primer/. You can set one up
16
+ using::
17
+
18
+ python -m venv venv
19
+
20
+ and then activate it on Windows by using ``venv/Scripts/activate``.
21
+
22
+ Installation
23
+ ------------
24
+
25
+ Install your package and its dependancies by using::
26
+
27
+ pip install -e .
28
+
29
+ Development
30
+ -----------
31
+
32
+ For developing the package, you'll want to install the pre-commit hooks as well. Type::
33
+
34
+ pre-commit install
35
+
36
+
37
+ Note that from now on when you commit, `black` will check your code for styling
38
+ errors. If it finds any it will correct them, but the commit will be aborted.
39
+ This is so that you can check its work before you continue. If you're happy,
40
+ just commit again.
41
+
42
+ Compatibility
43
+ -------------
44
+
45
+ Licence
46
+ -------
47
+
48
+ Authors
49
+ -------
50
+
51
+ `scrappi` was written by `Sam Hunt <sam.hunt@npl.co.uk>`_.
@@ -0,0 +1,9 @@
1
+ """scrappi - EO Satellite product catalogue retrieval by API or file system"""
2
+
3
+ __author__ = "Sam Hunt <sam.hunt@npl.co.uk>"
4
+ __all__ = []
5
+
6
+ from ._version import get_versions
7
+
8
+ __version__ = get_versions()["version"]
9
+ del get_versions
@@ -0,0 +1,21 @@
1
+
2
+ # This file was generated by 'versioneer.py' (0.18) from
3
+ # revision-control system data, or from the parent directory name of an
4
+ # unpacked source archive. Distribution tarballs contain a pre-generated copy
5
+ # of this file.
6
+
7
+ import json
8
+
9
+ version_json = '''
10
+ {
11
+ "date": "2023-02-20T09:26:28+0000",
12
+ "dirty": false,
13
+ "error": null,
14
+ "full-revisionid": "acf153509f59a0218ecde39090c57efcc06b725d",
15
+ "version": "v0.0"
16
+ }
17
+ ''' # END VERSION_JSON
18
+
19
+
20
+ def get_versions():
21
+ return json.loads(version_json)
File without changes
@@ -0,0 +1,29 @@
1
+ """describe class"""
2
+
3
+ """___Built-In Modules___"""
4
+ #import here
5
+
6
+ """___Third-Party Modules___"""
7
+ #import here
8
+
9
+ """___NPL Modules___"""
10
+ #import here
11
+
12
+ """___Authorship___"""
13
+ __author__ = "Pieter De Vis"
14
+ __created__ = "01/02/2021"
15
+ __maintainer__ = "Pieter De Vis"
16
+ __email__ = "pieter.de.vis@npl.co.uk"
17
+ __status__ = "Development"
18
+
19
+
20
+ class ClassName:
21
+ def __init__(
22
+ self,
23
+ something
24
+ ):
25
+ self.something = something
26
+
27
+ def function1(self, argument1, argument2):
28
+ return argument1+argument2
29
+
@@ -0,0 +1,26 @@
1
+ """Tests for classname module"""
2
+
3
+ """___Built-In Modules___"""
4
+ #import here
5
+
6
+ """___Third-Party Modules___"""
7
+ import unittest
8
+
9
+ """___NPL Modules___"""
10
+ #import here
11
+
12
+ """___Authorship___"""
13
+ __author__ = "Pieter De Vis"
14
+ __created__ = "01/02/2021"
15
+ __maintainer__ = "Pieter De Vis"
16
+ __email__ = "pieter.de.vis@npl.co.uk"
17
+ __status__ = "Development"
18
+
19
+
20
+ class TestClassName(unittest.TestCase):
21
+ def test_function1(self):
22
+ pass
23
+
24
+ if __name__ == "__main__":
25
+ unittest.main()
26
+
@@ -0,0 +1,70 @@
1
+ Metadata-Version: 2.1
2
+ Name: scrappi
3
+ Version: 0.0
4
+ Summary: EO Satellite product catalogue retrieval by API or file system
5
+ Home-page: https://gitlab.npl.co.uk/eco/tools/scrappi
6
+ Author: Sam Hunt
7
+ Author-email: sam.hunt@npl.co.uk
8
+ License: None
9
+ Classifier: Development Status :: 2 - Pre-Alpha
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.6
12
+ Classifier: Programming Language :: Python :: 3.7
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Provides-Extra: dev
15
+ Requires-Dist: pre-commit; extra == "dev"
16
+ Requires-Dist: tox; extra == "dev"
17
+ Requires-Dist: sphinx; extra == "dev"
18
+ Requires-Dist: sphinx_rtd_theme; extra == "dev"
19
+
20
+ scrappi
21
+ =======
22
+
23
+ EO Satellite product catalogue retrieval by API or file system
24
+
25
+ Usage
26
+ =====
27
+
28
+ Virtual environment
29
+ -------------------
30
+
31
+ It's always recommended to make a virtual environment for each of your python
32
+ projects. Use your preferred virtual environment manager if you want and
33
+ activate it for the rest of these commands. If you're unfamiliar, read
34
+ https://realpython.com/python-virtual-environments-a-primer/. You can set one up
35
+ using::
36
+
37
+ python -m venv venv
38
+
39
+ and then activate it on Windows by using ``venv/Scripts/activate``.
40
+
41
+ Installation
42
+ ------------
43
+
44
+ Install your package and its dependancies by using::
45
+
46
+ pip install -e .
47
+
48
+ Development
49
+ -----------
50
+
51
+ For developing the package, you'll want to install the pre-commit hooks as well. Type::
52
+
53
+ pre-commit install
54
+
55
+
56
+ Note that from now on when you commit, `black` will check your code for styling
57
+ errors. If it finds any it will correct them, but the commit will be aborted.
58
+ This is so that you can check its work before you continue. If you're happy,
59
+ just commit again.
60
+
61
+ Compatibility
62
+ -------------
63
+
64
+ Licence
65
+ -------
66
+
67
+ Authors
68
+ -------
69
+
70
+ `scrappi` was written by `Sam Hunt <sam.hunt@npl.co.uk>`_.
@@ -0,0 +1,17 @@
1
+ MANIFEST.in
2
+ README.rst
3
+ setup.cfg
4
+ setup.py
5
+ versioneer.py
6
+ scrappi/__init__.py
7
+ scrappi/_version.py
8
+ scrappi.egg-info/PKG-INFO
9
+ scrappi.egg-info/SOURCES.txt
10
+ scrappi.egg-info/dependency_links.txt
11
+ scrappi.egg-info/requires.txt
12
+ scrappi.egg-info/top_level.txt
13
+ scrappi/submodule_template/__init__.py
14
+ scrappi/submodule_template/class_template.py
15
+ scrappi/submodule_template/tests/__init__.py
16
+ scrappi/submodule_template/tests/test_class_template.py
17
+ tests/test_sample.py
@@ -0,0 +1,6 @@
1
+
2
+ [dev]
3
+ pre-commit
4
+ tox
5
+ sphinx
6
+ sphinx_rtd_theme
@@ -0,0 +1 @@
1
+ scrappi
scrappi-0.0/setup.cfg ADDED
@@ -0,0 +1,30 @@
1
+ [versioneer]
2
+ VCS = git
3
+ style = pep440
4
+ versionfile_source = scrappi/_version.py
5
+ versionfile_build = scrappi/_version.py
6
+ tag_prefix =
7
+ parentdir_prefix =
8
+
9
+ [flake8]
10
+ exclude = docs
11
+ max-line-length = 120
12
+ extend-ignore = W291
13
+
14
+ [mypy]
15
+ allow_untyped_globals = True
16
+ ignore_missing_imports = True
17
+
18
+ [mypy-setup]
19
+ ignore_errors = True
20
+
21
+ [mypy-tests]
22
+ ignore_errors = True
23
+
24
+ [mypy-versioneer]
25
+ ignore_errors = True
26
+
27
+ [egg_info]
28
+ tag_build =
29
+ tag_date = 0
30
+
scrappi-0.0/setup.py ADDED
@@ -0,0 +1,37 @@
1
+ import io
2
+ import os
3
+ import re
4
+
5
+ from setuptools import find_packages
6
+ from setuptools import setup
7
+ import versioneer
8
+
9
+
10
+ def read(filename):
11
+ filename = os.path.join(os.path.dirname(__file__), filename)
12
+ text_type = type(u"")
13
+ with io.open(filename, mode="r", encoding="utf-8") as fd:
14
+ return re.sub(text_type(r":[a-z]+:`~?(.*?)`"), text_type(r"``\1``"), fd.read())
15
+
16
+
17
+ setup(
18
+ version=versioneer.get_version(),
19
+ cmdclass=versioneer.get_cmdclass(),
20
+ name="scrappi",
21
+ url="https://gitlab.npl.co.uk/eco/tools/scrappi",
22
+ license="None",
23
+ author="Sam Hunt",
24
+ author_email="sam.hunt@npl.co.uk",
25
+ description="EO Satellite product catalogue retrieval by API or file system",
26
+ long_description=read("README.rst"),
27
+ packages=find_packages(exclude=("tests",)),
28
+ install_requires=[],
29
+ extras_require={"dev": ["pre-commit", "tox", "sphinx", "sphinx_rtd_theme"]},
30
+ classifiers=[
31
+ "Development Status :: 2 - Pre-Alpha",
32
+ "Programming Language :: Python",
33
+ "Programming Language :: Python :: 3.6",
34
+ "Programming Language :: Python :: 3.7",
35
+ "Programming Language :: Python :: 3.8",
36
+ ],
37
+ )
@@ -0,0 +1,13 @@
1
+ """Sample unit tests"""
2
+
3
+ import pytest
4
+
5
+
6
+ def test_pass():
7
+ assert True, "dummy sample test"
8
+
9
+
10
+ @pytest.mark.slow
11
+ def test_slow():
12
+ print("This is a very slow test which will sometimes be skipped (see the readme)")
13
+ assert True