datakit-data 0.3.0__tar.gz → 0.4.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.
- datakit_data-0.4.0/PKG-INFO +12 -0
- datakit_data-0.4.0/datakit_data/__init__.py +6 -0
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/commands/pull.py +7 -0
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/commands/push.py +1 -1
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/project_mixin.py +0 -1
- datakit_data-0.4.0/pyproject.toml +58 -0
- datakit-data-0.3.0/AUTHORS.rst +0 -11
- datakit-data-0.3.0/CONTRIBUTING.rst +0 -106
- datakit-data-0.3.0/HISTORY.rst +0 -19
- datakit-data-0.3.0/LICENSE +0 -9
- datakit-data-0.3.0/MANIFEST.in +0 -13
- datakit-data-0.3.0/PKG-INFO +0 -32
- datakit-data-0.3.0/README.rst +0 -19
- datakit-data-0.3.0/datakit_data/__init__.py +0 -9
- datakit-data-0.3.0/datakit_data.egg-info/PKG-INFO +0 -32
- datakit-data-0.3.0/datakit_data.egg-info/SOURCES.txt +0 -44
- datakit-data-0.3.0/datakit_data.egg-info/dependency_links.txt +0 -1
- datakit-data-0.3.0/datakit_data.egg-info/entry_points.txt +0 -5
- datakit-data-0.3.0/datakit_data.egg-info/not-zip-safe +0 -1
- datakit-data-0.3.0/datakit_data.egg-info/requires.txt +0 -3
- datakit-data-0.3.0/datakit_data.egg-info/top_level.txt +0 -1
- datakit-data-0.3.0/docs/Makefile +0 -177
- datakit-data-0.3.0/docs/authors.rst +0 -1
- datakit-data-0.3.0/docs/conf.py +0 -275
- datakit-data-0.3.0/docs/contributing.rst +0 -1
- datakit-data-0.3.0/docs/credits.rst +0 -10
- datakit-data-0.3.0/docs/datakit_data.commands.rst +0 -38
- datakit-data-0.3.0/docs/datakit_data.rst +0 -45
- datakit-data-0.3.0/docs/history.rst +0 -1
- datakit-data-0.3.0/docs/index.rst +0 -23
- datakit-data-0.3.0/docs/installation.rst +0 -35
- datakit-data-0.3.0/docs/make.bat +0 -242
- datakit-data-0.3.0/docs/modules.rst +0 -7
- datakit-data-0.3.0/docs/quickstart.rst +0 -35
- datakit-data-0.3.0/docs/readme.rst +0 -73
- datakit-data-0.3.0/docs/usage.rst +0 -225
- datakit-data-0.3.0/setup.cfg +0 -25
- datakit-data-0.3.0/setup.py +0 -62
- datakit-data-0.3.0/tests/commands/test_init.py +0 -130
- datakit-data-0.3.0/tests/commands/test_pull.py +0 -91
- datakit-data-0.3.0/tests/commands/test_push.py +0 -70
- datakit-data-0.3.0/tests/conftest.py +0 -46
- datakit-data-0.3.0/tests/test_extra_flags.py +0 -13
- datakit-data-0.3.0/tests/test_s3.py +0 -99
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/commands/__init__.py +0 -0
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/commands/init.py +0 -0
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/extra_flags.py +0 -0
- {datakit-data-0.3.0 → datakit_data-0.4.0}/datakit_data/s3.py +0 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: datakit-data
|
|
3
|
+
Version: 0.4.0
|
|
4
|
+
Summary: A datakit plugin to manage data assets on AWS S3.
|
|
5
|
+
Author: Larry Fenn
|
|
6
|
+
Author-email: Larry Fenn <lfenn@ap.org>
|
|
7
|
+
License: ISC
|
|
8
|
+
Requires-Dist: awscli
|
|
9
|
+
Requires-Dist: cliff
|
|
10
|
+
Requires-Dist: datakit-core>=0.2.1
|
|
11
|
+
Requires-Python: >=3.10
|
|
12
|
+
Project-URL: Homepage, https://github.com/associatedpress/datakit-data
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# -*- coding: utf-8 -*-
|
|
2
2
|
import argparse
|
|
3
|
+
import os
|
|
3
4
|
from cliff.command import Command
|
|
4
5
|
from datakit import CommandHelpers
|
|
5
6
|
|
|
@@ -25,6 +26,12 @@ class Pull(ProjectMixin, CommandHelpers, Command):
|
|
|
25
26
|
def take_action(self, parsed_args):
|
|
26
27
|
user_profile = self.project_configs['aws_user_profile']
|
|
27
28
|
bucket = self.project_configs['s3_bucket']
|
|
29
|
+
if not os.path.exists("config/datakit-data.json"):
|
|
30
|
+
self.log.info("No config file found - have you run `datakit data init`?")
|
|
31
|
+
return
|
|
32
|
+
if bucket == "":
|
|
33
|
+
self.log.info("No bucket specified in config - no data pushed")
|
|
34
|
+
return
|
|
28
35
|
s3 = S3(user_profile, bucket)
|
|
29
36
|
clean_flags = ExtraFlags.convert(parsed_args.args)
|
|
30
37
|
s3.pull(
|
|
@@ -29,7 +29,7 @@ class Push(ProjectMixin, CommandHelpers, Command):
|
|
|
29
29
|
if not os.path.exists("config/datakit-data.json"):
|
|
30
30
|
self.log.info("No config file found - have you run `datakit data init`?")
|
|
31
31
|
return
|
|
32
|
-
if bucket
|
|
32
|
+
if bucket == "":
|
|
33
33
|
self.log.info("No bucket specified in config - no data pushed")
|
|
34
34
|
return
|
|
35
35
|
s3 = S3(user_profile, bucket)
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["uv-build"]
|
|
3
|
+
build-backend = "uv_build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "datakit-data"
|
|
7
|
+
version = "0.4.0"
|
|
8
|
+
description = "A datakit plugin to manage data assets on AWS S3."
|
|
9
|
+
authors = [
|
|
10
|
+
{name = "Larry Fenn", email = "lfenn@ap.org"},
|
|
11
|
+
]
|
|
12
|
+
license = {text = "ISC"}
|
|
13
|
+
requires-python = ">=3.10"
|
|
14
|
+
dependencies = [
|
|
15
|
+
"awscli",
|
|
16
|
+
"cliff",
|
|
17
|
+
"datakit-core>=0.2.1",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project.urls]
|
|
21
|
+
Homepage = "https://github.com/associatedpress/datakit-data"
|
|
22
|
+
|
|
23
|
+
[project.entry-points."datakit.plugins"]
|
|
24
|
+
"data init" = "datakit_data:Init"
|
|
25
|
+
"data push" = "datakit_data:Push"
|
|
26
|
+
"data pull" = "datakit_data:Pull"
|
|
27
|
+
|
|
28
|
+
[dependency-groups]
|
|
29
|
+
dev = [
|
|
30
|
+
"bumpversion",
|
|
31
|
+
"coverage",
|
|
32
|
+
"cryptography>=42.0.4",
|
|
33
|
+
"ruff",
|
|
34
|
+
"pytest",
|
|
35
|
+
"pytest-mock",
|
|
36
|
+
"Sphinx",
|
|
37
|
+
"tox",
|
|
38
|
+
"tox-uv",
|
|
39
|
+
"watchdog",
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
[tool.uv.build-backend]
|
|
43
|
+
module-root = ""
|
|
44
|
+
|
|
45
|
+
[tool.tox]
|
|
46
|
+
env_list = ["py311", "py312", "py313"]
|
|
47
|
+
|
|
48
|
+
[tool.tox.env_run_base]
|
|
49
|
+
dependency_groups = ["dev"]
|
|
50
|
+
commands = [["pytest", "{posargs}"]]
|
|
51
|
+
|
|
52
|
+
[tool.ruff]
|
|
53
|
+
line-length = 130
|
|
54
|
+
exclude = ["docs", "datakit_data/__init__.py"]
|
|
55
|
+
|
|
56
|
+
[tool.pytest.ini_options]
|
|
57
|
+
testpaths = ["tests/"]
|
|
58
|
+
log_level = "INFO"
|
datakit-data-0.3.0/AUTHORS.rst
DELETED
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
.. highlight:: shell
|
|
2
|
-
|
|
3
|
-
============
|
|
4
|
-
Contributing
|
|
5
|
-
============
|
|
6
|
-
|
|
7
|
-
Contributions are welcome, and they are greatly appreciated! Every
|
|
8
|
-
little bit helps, and credit will always be given.
|
|
9
|
-
|
|
10
|
-
You can contribute in many ways:
|
|
11
|
-
|
|
12
|
-
Types of Contributions
|
|
13
|
-
----------------------
|
|
14
|
-
|
|
15
|
-
Report Bugs
|
|
16
|
-
~~~~~~~~~~~
|
|
17
|
-
|
|
18
|
-
Report bugs at https://github.com/associatedpress/datakit-data/issues.
|
|
19
|
-
|
|
20
|
-
If you are reporting a bug, please include:
|
|
21
|
-
|
|
22
|
-
* Your operating system name and version.
|
|
23
|
-
* Any details about your local setup that might be helpful in troubleshooting.
|
|
24
|
-
* Detailed steps to reproduce the bug.
|
|
25
|
-
|
|
26
|
-
Fix Bugs
|
|
27
|
-
~~~~~~~~
|
|
28
|
-
|
|
29
|
-
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
|
30
|
-
and "help wanted" is open to whoever wants to implement it.
|
|
31
|
-
|
|
32
|
-
Implement Features
|
|
33
|
-
~~~~~~~~~~~~~~~~~~
|
|
34
|
-
|
|
35
|
-
Look through the GitHub issues for features. Anything tagged with "enhancement"
|
|
36
|
-
and "help wanted" is open to whoever wants to implement it.
|
|
37
|
-
|
|
38
|
-
Write Documentation
|
|
39
|
-
~~~~~~~~~~~~~~~~~~~
|
|
40
|
-
|
|
41
|
-
datakit-data plugin could always use more documentation, whether as part of the
|
|
42
|
-
official datakit-data plugin docs, in docstrings, or even on the web in blog posts,
|
|
43
|
-
articles, and such.
|
|
44
|
-
|
|
45
|
-
Submit Feedback
|
|
46
|
-
~~~~~~~~~~~~~~~
|
|
47
|
-
|
|
48
|
-
The best way to send feedback is to file an issue at https://github.com/associatedpress/datakit-data/issues.
|
|
49
|
-
|
|
50
|
-
If you are proposing a feature:
|
|
51
|
-
|
|
52
|
-
* Explain in detail how it would work.
|
|
53
|
-
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
54
|
-
* Remember that this is a volunteer-driven project, and that contributions
|
|
55
|
-
are welcome :)
|
|
56
|
-
|
|
57
|
-
Get Started!
|
|
58
|
-
------------
|
|
59
|
-
|
|
60
|
-
Ready to contribute? Here's how to set up `datakit-data` for local development.
|
|
61
|
-
|
|
62
|
-
1. Fork the `datakit-data` repo on GitHub.
|
|
63
|
-
2. Clone your fork locally::
|
|
64
|
-
|
|
65
|
-
$ git clone git@github.com:your_name_here/datakit-data.git
|
|
66
|
-
|
|
67
|
-
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
|
|
68
|
-
|
|
69
|
-
$ mkvirtualenv datakit-data
|
|
70
|
-
$ cd datakit-data/
|
|
71
|
-
$ python setup.py develop
|
|
72
|
-
|
|
73
|
-
4. Create a branch for local development::
|
|
74
|
-
|
|
75
|
-
$ git checkout -b name-of-your-bugfix-or-feature
|
|
76
|
-
|
|
77
|
-
Now you can make your changes locally.
|
|
78
|
-
|
|
79
|
-
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
|
|
80
|
-
|
|
81
|
-
$ flake8 datakit_data tests
|
|
82
|
-
$ py.test
|
|
83
|
-
$ tox
|
|
84
|
-
|
|
85
|
-
To get flake8 and tox, just pip install them into your virtualenv.
|
|
86
|
-
|
|
87
|
-
6. Commit your changes and push your branch to GitHub::
|
|
88
|
-
|
|
89
|
-
$ git add .
|
|
90
|
-
$ git commit -m "Your detailed description of your changes."
|
|
91
|
-
$ git push origin name-of-your-bugfix-or-feature
|
|
92
|
-
|
|
93
|
-
7. Submit a pull request through the GitHub website.
|
|
94
|
-
|
|
95
|
-
Pull Request Guidelines
|
|
96
|
-
-----------------------
|
|
97
|
-
|
|
98
|
-
Before you submit a pull request, check that it meets these guidelines:
|
|
99
|
-
|
|
100
|
-
1. The pull request should include tests.
|
|
101
|
-
2. If the pull request adds functionality, the docs should be updated. Put
|
|
102
|
-
your new functionality into a function with a docstring, and add the
|
|
103
|
-
feature to the list in README.rst.
|
|
104
|
-
3. The pull request should work for Python version 3.3 or higher. Check
|
|
105
|
-
https://travis-ci.org/associatedpress/datakit-data/pull_requests
|
|
106
|
-
and make sure that the tests pass for all supported Python versions.
|
datakit-data-0.3.0/HISTORY.rst
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
=======
|
|
2
|
-
History
|
|
3
|
-
=======
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
0.2.0 (2018-01-17)
|
|
7
|
-
------------------
|
|
8
|
-
|
|
9
|
-
* Switch from colon- to space-separated plugin commands
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
0.1.0 (2016-03-16)
|
|
13
|
-
------------------
|
|
14
|
-
|
|
15
|
-
* Project initialization command
|
|
16
|
-
* Push/Pull commands
|
|
17
|
-
* Custom syntax for pass-through of boolean flags to aws sync utility
|
|
18
|
-
* Project-level configuration inheritance from global configs
|
|
19
|
-
* Support for customizing S3 path with prefix/suffix from global configs
|
datakit-data-0.3.0/LICENSE
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
ISC License
|
|
3
|
-
|
|
4
|
-
Copyright (c) 2017, Associated Press
|
|
5
|
-
|
|
6
|
-
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
|
|
7
|
-
|
|
8
|
-
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
9
|
-
|
datakit-data-0.3.0/MANIFEST.in
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
include AUTHORS.rst
|
|
3
|
-
|
|
4
|
-
include CONTRIBUTING.rst
|
|
5
|
-
include HISTORY.rst
|
|
6
|
-
include LICENSE
|
|
7
|
-
include README.rst
|
|
8
|
-
|
|
9
|
-
recursive-include tests *
|
|
10
|
-
recursive-exclude * __pycache__
|
|
11
|
-
recursive-exclude * *.py[co]
|
|
12
|
-
|
|
13
|
-
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
|
datakit-data-0.3.0/PKG-INFO
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 1.1
|
|
2
|
-
Name: datakit-data
|
|
3
|
-
Version: 0.3.0
|
|
4
|
-
Summary: A datakit plugin to manage data assets on AWS S3.
|
|
5
|
-
Home-page: https://github.com/associatedpress/datakit-data
|
|
6
|
-
Author: Serdar Tumgoren
|
|
7
|
-
Author-email: stumgoren@ap.org
|
|
8
|
-
License: ISC license
|
|
9
|
-
Description:
|
|
10
|
-
|
|
11
|
-
datakit-data
|
|
12
|
-
---------------
|
|
13
|
-
|
|
14
|
-
A `datakit <https://pypi.python.org/pypi/datakit-core/>`_ plugin to simplify use of
|
|
15
|
-
Amazon S3 as a data store for data science projects.
|
|
16
|
-
|
|
17
|
-
* `Code <https://github.com/associatedpress/datakit-data>`_
|
|
18
|
-
* `Docs <http://datakit-data.readthedocs.io/en/latest/>`_
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
Keywords: datakit
|
|
22
|
-
Platform: UNKNOWN
|
|
23
|
-
Classifier: Development Status :: 3 - Alpha
|
|
24
|
-
Classifier: Environment :: Console
|
|
25
|
-
Classifier: Intended Audience :: Developers
|
|
26
|
-
Classifier: License :: OSI Approved :: ISC License (ISCL)
|
|
27
|
-
Classifier: Natural Language :: English
|
|
28
|
-
Classifier: Programming Language :: Python :: 3
|
|
29
|
-
Classifier: Programming Language :: Python :: 3.3
|
|
30
|
-
Classifier: Programming Language :: Python :: 3.4
|
|
31
|
-
Classifier: Programming Language :: Python :: 3.5
|
|
32
|
-
Classifier: Programming Language :: Python :: 3.6
|
datakit-data-0.3.0/README.rst
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
.. image:: https://img.shields.io/pypi/v/datakit-data.svg
|
|
3
|
-
:target: https://pypi.python.org/pypi/datakit-data
|
|
4
|
-
|
|
5
|
-
.. image:: https://img.shields.io/travis/associatedpress/datakit-data.svg
|
|
6
|
-
:target: https://travis-ci.org/associatedpress/datakit-data
|
|
7
|
-
|
|
8
|
-
.. image:: http://readthedocs.org/projects/datakit-data/badge/?version=latest
|
|
9
|
-
:target: https://datakit-data.readthedocs.io/en/latest/
|
|
10
|
-
:alt: Documentation Status
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
The `datakit-data` package is a datakit_ plugin designed to help data analysts
|
|
14
|
-
easily archive and share data assets on S3.
|
|
15
|
-
|
|
16
|
-
Please see the `official docs`_ for details on installation and usage.
|
|
17
|
-
|
|
18
|
-
.. _datakit: https://github.com/associatedpress/datakit-core
|
|
19
|
-
.. _`official docs`: https://datakit-data.readthedocs.io/en/latest/
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 1.1
|
|
2
|
-
Name: datakit-data
|
|
3
|
-
Version: 0.3.0
|
|
4
|
-
Summary: A datakit plugin to manage data assets on AWS S3.
|
|
5
|
-
Home-page: https://github.com/associatedpress/datakit-data
|
|
6
|
-
Author: Serdar Tumgoren
|
|
7
|
-
Author-email: stumgoren@ap.org
|
|
8
|
-
License: ISC license
|
|
9
|
-
Description:
|
|
10
|
-
|
|
11
|
-
datakit-data
|
|
12
|
-
---------------
|
|
13
|
-
|
|
14
|
-
A `datakit <https://pypi.python.org/pypi/datakit-core/>`_ plugin to simplify use of
|
|
15
|
-
Amazon S3 as a data store for data science projects.
|
|
16
|
-
|
|
17
|
-
* `Code <https://github.com/associatedpress/datakit-data>`_
|
|
18
|
-
* `Docs <http://datakit-data.readthedocs.io/en/latest/>`_
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
Keywords: datakit
|
|
22
|
-
Platform: UNKNOWN
|
|
23
|
-
Classifier: Development Status :: 3 - Alpha
|
|
24
|
-
Classifier: Environment :: Console
|
|
25
|
-
Classifier: Intended Audience :: Developers
|
|
26
|
-
Classifier: License :: OSI Approved :: ISC License (ISCL)
|
|
27
|
-
Classifier: Natural Language :: English
|
|
28
|
-
Classifier: Programming Language :: Python :: 3
|
|
29
|
-
Classifier: Programming Language :: Python :: 3.3
|
|
30
|
-
Classifier: Programming Language :: Python :: 3.4
|
|
31
|
-
Classifier: Programming Language :: Python :: 3.5
|
|
32
|
-
Classifier: Programming Language :: Python :: 3.6
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
AUTHORS.rst
|
|
2
|
-
CONTRIBUTING.rst
|
|
3
|
-
HISTORY.rst
|
|
4
|
-
LICENSE
|
|
5
|
-
MANIFEST.in
|
|
6
|
-
README.rst
|
|
7
|
-
setup.cfg
|
|
8
|
-
setup.py
|
|
9
|
-
datakit_data/__init__.py
|
|
10
|
-
datakit_data/extra_flags.py
|
|
11
|
-
datakit_data/project_mixin.py
|
|
12
|
-
datakit_data/s3.py
|
|
13
|
-
datakit_data.egg-info/PKG-INFO
|
|
14
|
-
datakit_data.egg-info/SOURCES.txt
|
|
15
|
-
datakit_data.egg-info/dependency_links.txt
|
|
16
|
-
datakit_data.egg-info/entry_points.txt
|
|
17
|
-
datakit_data.egg-info/not-zip-safe
|
|
18
|
-
datakit_data.egg-info/requires.txt
|
|
19
|
-
datakit_data.egg-info/top_level.txt
|
|
20
|
-
datakit_data/commands/__init__.py
|
|
21
|
-
datakit_data/commands/init.py
|
|
22
|
-
datakit_data/commands/pull.py
|
|
23
|
-
datakit_data/commands/push.py
|
|
24
|
-
docs/Makefile
|
|
25
|
-
docs/authors.rst
|
|
26
|
-
docs/conf.py
|
|
27
|
-
docs/contributing.rst
|
|
28
|
-
docs/credits.rst
|
|
29
|
-
docs/datakit_data.commands.rst
|
|
30
|
-
docs/datakit_data.rst
|
|
31
|
-
docs/history.rst
|
|
32
|
-
docs/index.rst
|
|
33
|
-
docs/installation.rst
|
|
34
|
-
docs/make.bat
|
|
35
|
-
docs/modules.rst
|
|
36
|
-
docs/quickstart.rst
|
|
37
|
-
docs/readme.rst
|
|
38
|
-
docs/usage.rst
|
|
39
|
-
tests/conftest.py
|
|
40
|
-
tests/test_extra_flags.py
|
|
41
|
-
tests/test_s3.py
|
|
42
|
-
tests/commands/test_init.py
|
|
43
|
-
tests/commands/test_pull.py
|
|
44
|
-
tests/commands/test_push.py
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
datakit_data
|
datakit-data-0.3.0/docs/Makefile
DELETED
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
# Makefile for Sphinx documentation
|
|
2
|
-
#
|
|
3
|
-
|
|
4
|
-
# You can set these variables from the command line.
|
|
5
|
-
SPHINXOPTS =
|
|
6
|
-
SPHINXBUILD = sphinx-build
|
|
7
|
-
PAPER =
|
|
8
|
-
BUILDDIR = _build
|
|
9
|
-
|
|
10
|
-
# User-friendly check for sphinx-build
|
|
11
|
-
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
|
12
|
-
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
|
13
|
-
endif
|
|
14
|
-
|
|
15
|
-
# Internal variables.
|
|
16
|
-
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
17
|
-
PAPEROPT_letter = -D latex_paper_size=letter
|
|
18
|
-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
19
|
-
# the i18n builder cannot share the environment and doctrees with the others
|
|
20
|
-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
21
|
-
|
|
22
|
-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
|
23
|
-
|
|
24
|
-
help:
|
|
25
|
-
@echo "Please use \`make <target>' where <target> is one of"
|
|
26
|
-
@echo " html to make standalone HTML files"
|
|
27
|
-
@echo " dirhtml to make HTML files named index.html in directories"
|
|
28
|
-
@echo " singlehtml to make a single large HTML file"
|
|
29
|
-
@echo " pickle to make pickle files"
|
|
30
|
-
@echo " json to make JSON files"
|
|
31
|
-
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
32
|
-
@echo " qthelp to make HTML files and a qthelp project"
|
|
33
|
-
@echo " devhelp to make HTML files and a Devhelp project"
|
|
34
|
-
@echo " epub to make an epub"
|
|
35
|
-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
36
|
-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
37
|
-
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
38
|
-
@echo " text to make text files"
|
|
39
|
-
@echo " man to make manual pages"
|
|
40
|
-
@echo " texinfo to make Texinfo files"
|
|
41
|
-
@echo " info to make Texinfo files and run them through makeinfo"
|
|
42
|
-
@echo " gettext to make PO message catalogs"
|
|
43
|
-
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
44
|
-
@echo " xml to make Docutils-native XML files"
|
|
45
|
-
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
46
|
-
@echo " linkcheck to check all external links for integrity"
|
|
47
|
-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
48
|
-
|
|
49
|
-
clean:
|
|
50
|
-
rm -rf $(BUILDDIR)/*
|
|
51
|
-
|
|
52
|
-
html:
|
|
53
|
-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
54
|
-
@echo
|
|
55
|
-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
56
|
-
|
|
57
|
-
dirhtml:
|
|
58
|
-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
59
|
-
@echo
|
|
60
|
-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
61
|
-
|
|
62
|
-
singlehtml:
|
|
63
|
-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
64
|
-
@echo
|
|
65
|
-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
66
|
-
|
|
67
|
-
pickle:
|
|
68
|
-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
69
|
-
@echo
|
|
70
|
-
@echo "Build finished; now you can process the pickle files."
|
|
71
|
-
|
|
72
|
-
json:
|
|
73
|
-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
74
|
-
@echo
|
|
75
|
-
@echo "Build finished; now you can process the JSON files."
|
|
76
|
-
|
|
77
|
-
htmlhelp:
|
|
78
|
-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
79
|
-
@echo
|
|
80
|
-
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
81
|
-
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
82
|
-
|
|
83
|
-
qthelp:
|
|
84
|
-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
85
|
-
@echo
|
|
86
|
-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
87
|
-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
88
|
-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/datakit-data.qhcp"
|
|
89
|
-
@echo "To view the help file:"
|
|
90
|
-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datakit-data.qhc"
|
|
91
|
-
|
|
92
|
-
devhelp:
|
|
93
|
-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
94
|
-
@echo
|
|
95
|
-
@echo "Build finished."
|
|
96
|
-
@echo "To view the help file:"
|
|
97
|
-
@echo "# mkdir -p $$HOME/.local/share/devhelp/datakit-data"
|
|
98
|
-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datakit-data"
|
|
99
|
-
@echo "# devhelp"
|
|
100
|
-
|
|
101
|
-
epub:
|
|
102
|
-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
103
|
-
@echo
|
|
104
|
-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
105
|
-
|
|
106
|
-
latex:
|
|
107
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
108
|
-
@echo
|
|
109
|
-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
110
|
-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
111
|
-
"(use \`make latexpdf' here to do that automatically)."
|
|
112
|
-
|
|
113
|
-
latexpdf:
|
|
114
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
115
|
-
@echo "Running LaTeX files through pdflatex..."
|
|
116
|
-
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
117
|
-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
118
|
-
|
|
119
|
-
latexpdfja:
|
|
120
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
121
|
-
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
122
|
-
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
123
|
-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
124
|
-
|
|
125
|
-
text:
|
|
126
|
-
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
127
|
-
@echo
|
|
128
|
-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
129
|
-
|
|
130
|
-
man:
|
|
131
|
-
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
132
|
-
@echo
|
|
133
|
-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
134
|
-
|
|
135
|
-
texinfo:
|
|
136
|
-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
137
|
-
@echo
|
|
138
|
-
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
139
|
-
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
140
|
-
"(use \`make info' here to do that automatically)."
|
|
141
|
-
|
|
142
|
-
info:
|
|
143
|
-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
144
|
-
@echo "Running Texinfo files through makeinfo..."
|
|
145
|
-
make -C $(BUILDDIR)/texinfo info
|
|
146
|
-
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
147
|
-
|
|
148
|
-
gettext:
|
|
149
|
-
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
150
|
-
@echo
|
|
151
|
-
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
152
|
-
|
|
153
|
-
changes:
|
|
154
|
-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
155
|
-
@echo
|
|
156
|
-
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
157
|
-
|
|
158
|
-
linkcheck:
|
|
159
|
-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
160
|
-
@echo
|
|
161
|
-
@echo "Link check complete; look for any errors in the above output " \
|
|
162
|
-
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
163
|
-
|
|
164
|
-
doctest:
|
|
165
|
-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
166
|
-
@echo "Testing of doctests in the sources finished, look at the " \
|
|
167
|
-
"results in $(BUILDDIR)/doctest/output.txt."
|
|
168
|
-
|
|
169
|
-
xml:
|
|
170
|
-
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
171
|
-
@echo
|
|
172
|
-
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
173
|
-
|
|
174
|
-
pseudoxml:
|
|
175
|
-
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
176
|
-
@echo
|
|
177
|
-
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
.. include:: ../AUTHORS.rst
|