datakit-data 0.2.0__tar.gz → 0.4.0__tar.gz

datakit_data-0.4.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.3
+Name: datakit-data
+Version: 0.4.0
+Summary: A datakit plugin to manage data assets on AWS S3.
+Author: Larry Fenn
+Author-email: Larry Fenn <lfenn@ap.org>
+License: ISC
+Requires-Dist: awscli
+Requires-Dist: cliff
+Requires-Dist: datakit-core>=0.2.1
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/associatedpress/datakit-data

datakit_data-0.4.0/datakit_data/__init__.py

@@ -0,0 +1,6 @@
+__author__ = """Larry Fenn"""
+__email__ = 'lfenn@ap.org'
+
+from .commands.init import Init
+from .commands.push import Push
+from .commands.pull import Pull

{datakit-data-0.2.0 → datakit_data-0.4.0}/datakit_data/commands/init.py

@@ -26,7 +26,9 @@ class Init(ProjectMixin, CommandHelpers, Command):
         dirs_to_create = ['data', 'config']
         [mkdir_p(directory) for directory in dirs_to_create]
         open('data/.gitkeep', 'w').close()
+        self.log.info("Created data/ directory")
         self.create_project_config()
+        self.log.info("Created config/datakit-data.json")
 
     def create_project_config(self):
         """Create project config if they don't already exist.
@@ -34,15 +36,18 @@ class Init(ProjectMixin, CommandHelpers, Command):
         Plugin-level configs, if configured, will override project defaults.
 
         """
-        if not os.path.exists(self.project_config_path):
-            try:
-                plugin_configs = read_json(self.plugin_config_path)
-            except FileNotFoundError:
-                plugin_configs = {}
-            to_write = self.default_configs.copy()
-            to_write.update(plugin_configs)
-            self.finalize_configs(to_write)
-            write_json(self.project_config_path, to_write)
+        if os.path.exists(self.project_config_path):
+            return
+        try:
+            plugin_configs = read_json(self.plugin_config_path)
+        except FileNotFoundError:
+            plugin_configs = {}
+            self.log.info(f"No user level config found at {self.plugin_config_path}, empty config created!")
+            self.log.info("You will need to fill out config/datakit-data.json manually")
+        to_write = self.default_configs.copy()
+        to_write.update(plugin_configs)
+        self.finalize_configs(to_write)
+        write_json(self.project_config_path, to_write)
 
     def finalize_configs(self, configs):
         prefix = self.pop_key(configs, 's3_path_prefix')

{datakit-data-0.2.0 → datakit_data-0.4.0}/datakit_data/commands/pull.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import argparse
+import os
 from cliff.command import Command
 from datakit import CommandHelpers
 
@@ -25,6 +26,12 @@ class Pull(ProjectMixin, CommandHelpers, Command):
     def take_action(self, parsed_args):
         user_profile = self.project_configs['aws_user_profile']
         bucket = self.project_configs['s3_bucket']
+        if not os.path.exists("config/datakit-data.json"):
+            self.log.info("No config file found - have you run `datakit data init`?")
+            return
+        if bucket == "":
+            self.log.info("No bucket specified in config - no data pushed")
+            return        
         s3 = S3(user_profile, bucket)
         clean_flags = ExtraFlags.convert(parsed_args.args)
         s3.pull(

{datakit-data-0.2.0 → datakit_data-0.4.0}/datakit_data/commands/push.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import argparse
+import os
 from cliff.command import Command
 from datakit import CommandHelpers
 
@@ -25,6 +26,12 @@ class Push(ProjectMixin, CommandHelpers, Command):
     def take_action(self, parsed_args):
         user_profile = self.project_configs['aws_user_profile']
         bucket = self.project_configs['s3_bucket']
+        if not os.path.exists("config/datakit-data.json"):
+            self.log.info("No config file found - have you run `datakit data init`?")
+            return
+        if bucket == "":
+            self.log.info("No bucket specified in config - no data pushed")
+            return
         s3 = S3(user_profile, bucket)
         clean_flags = ExtraFlags.convert(parsed_args.args)
         s3.push(

{datakit-data-0.2.0 → datakit_data-0.4.0}/datakit_data/project_mixin.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import os
 
 from datakit.utils import read_json

datakit_data-0.4.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["uv-build"]
+build-backend = "uv_build"
+
+[project]
+name = "datakit-data"
+version = "0.4.0"
+description = "A datakit plugin to manage data assets on AWS S3."
+authors = [
+    {name = "Larry Fenn", email = "lfenn@ap.org"},
+]
+license = {text = "ISC"}
+requires-python = ">=3.10"
+dependencies = [
+    "awscli",
+    "cliff",
+    "datakit-core>=0.2.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/associatedpress/datakit-data"
+
+[project.entry-points."datakit.plugins"]
+"data init" = "datakit_data:Init"
+"data push" = "datakit_data:Push"
+"data pull" = "datakit_data:Pull"
+
+[dependency-groups]
+dev = [
+    "bumpversion",
+    "coverage",
+    "cryptography>=42.0.4",
+    "ruff",
+    "pytest",
+    "pytest-mock",
+    "Sphinx",
+    "tox",
+    "tox-uv",
+    "watchdog",
+]
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.tox]
+env_list = ["py311", "py312", "py313"]
+
+[tool.tox.env_run_base]
+dependency_groups = ["dev"]
+commands = [["pytest", "{posargs}"]]
+
+[tool.ruff]
+line-length = 130
+exclude = ["docs", "datakit_data/__init__.py"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests/"]
+log_level = "INFO"

datakit-data-0.2.0/AUTHORS.rst

@@ -1,11 +0,0 @@
-============
-Contributors
-============
-
-**Development Lead**
-
-* Serdar Tumgoren <stumgoren@ap.org>
-
-**Contributors**
-
-* Michelle Minkoff <mminkoff@ap.org>

datakit-data-0.2.0/CONTRIBUTING.rst

@@ -1,106 +0,0 @@
-.. highlight:: shell
-
-============
-Contributing
-============
-
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-Types of Contributions
-----------------------
-
-Report Bugs
-~~~~~~~~~~~
-
-Report bugs at https://github.com/associatedpress/datakit-data/issues.
-
-If you are reporting a bug, please include:
-
-* Your operating system name and version.
-* Any details about your local setup that might be helpful in troubleshooting.
-* Detailed steps to reproduce the bug.
-
-Fix Bugs
-~~~~~~~~
-
-Look through the GitHub issues for bugs. Anything tagged with "bug"
-and "help wanted" is open to whoever wants to implement it.
-
-Implement Features
-~~~~~~~~~~~~~~~~~~
-
-Look through the GitHub issues for features. Anything tagged with "enhancement"
-and "help wanted" is open to whoever wants to implement it.
-
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
-
-datakit-data plugin could always use more documentation, whether as part of the
-official datakit-data plugin docs, in docstrings, or even on the web in blog posts,
-articles, and such.
-
-Submit Feedback
-~~~~~~~~~~~~~~~
-
-The best way to send feedback is to file an issue at https://github.com/associatedpress/datakit-data/issues.
-
-If you are proposing a feature:
-
-* Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
-  are welcome :)
-
-Get Started!
-------------
-
-Ready to contribute? Here's how to set up `datakit-data` for local development.
-
-1. Fork the `datakit-data` repo on GitHub.
-2. Clone your fork locally::
-
-    $ git clone git@github.com:your_name_here/datakit-data.git
-
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
-
-    $ mkvirtualenv datakit-data
-    $ cd datakit-data/
-    $ python setup.py develop
-
-4. Create a branch for local development::
-
-    $ git checkout -b name-of-your-bugfix-or-feature
-
-   Now you can make your changes locally.
-
-5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
-
-    $ flake8 datakit_data tests
-    $ py.test
-    $ tox
-
-   To get flake8 and tox, just pip install them into your virtualenv.
-
-6. Commit your changes and push your branch to GitHub::
-
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
-
-7. Submit a pull request through the GitHub website.
-
-Pull Request Guidelines
------------------------
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python version 3.3 or higher. Check
-   https://travis-ci.org/associatedpress/datakit-data/pull_requests
-   and make sure that the tests pass for all supported Python versions.

datakit-data-0.2.0/HISTORY.rst

@@ -1,19 +0,0 @@
-=======
-History
-=======
-
-
-0.2.0 (2018-01-17)
-------------------
-
-* Switch from colon- to space-separated plugin commands
-
-
-0.1.0 (2016-03-16)
-------------------
-
-* Project initialization command
-* Push/Pull commands
-* Custom syntax for pass-through of boolean flags to aws sync utility
-* Project-level configuration inheritance from global configs
-* Support for customizing S3 path with prefix/suffix from global configs

datakit-data-0.2.0/LICENSE

@@ -1,9 +0,0 @@
-
-ISC License
-
-Copyright (c) 2017, Associated Press
-
-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.
-
-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.
-

datakit-data-0.2.0/MANIFEST.in

@@ -1,13 +0,0 @@
-
-include AUTHORS.rst
-
-include CONTRIBUTING.rst
-include HISTORY.rst
-include LICENSE
-include README.rst
-
-recursive-include tests *
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-
-recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

datakit-data-0.2.0/PKG-INFO

@@ -1,32 +0,0 @@
-Metadata-Version: 1.1
-Name: datakit-data
-Version: 0.2.0
-Summary: A datakit plugin to manage data assets on AWS S3.
-Home-page: https://github.com/associatedpress/datakit-data
-Author: Serdar Tumgoren
-Author-email: stumgoren@ap.org
-License: ISC license
-Description-Content-Type: UNKNOWN
-Description: 
-        
-        datakit-data
-        ---------------
-        
-        A `datakit <https://pypi.python.org/pypi/datakit-core/>`_ plugin to simplify use of
-        Amazon S3 as a data store for data science projects.
-        
-        * `Code <https://github.com/associatedpress/datakit-data>`_
-        * `Docs <http://datakit-data.readthedocs.io/en/latest/>`_
-        
-        
-Keywords: datakit
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: ISC License (ISCL)
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5

datakit-data-0.2.0/README.rst

@@ -1,19 +0,0 @@
-
-.. image:: https://img.shields.io/pypi/v/datakit-data.svg
-        :target: https://pypi.python.org/pypi/datakit-data
-
-.. image:: https://img.shields.io/travis/associatedpress/datakit-data.svg
-        :target: https://travis-ci.org/associatedpress/datakit-data
-        
-.. image:: http://readthedocs.org/projects/datakit-data/badge/?version=latest
-   :target: https://datakit-data.readthedocs.io/en/latest/
-   :alt: Documentation Status
-                
-
-The `datakit-data` package is a datakit_ plugin designed to help data analysts
-easily archive and share data assets on S3.
-
-Please see the `official docs`_ for details on installation and usage.
-
-.. _datakit: https://github.com/associatedpress/datakit-core
-.. _`official docs`: https://datakit-data.readthedocs.io/en/latest/

datakit-data-0.2.0/datakit_data/__init__.py

@@ -1,9 +0,0 @@
-# -*- coding: utf-8 -*-
-
-__author__ = """Serdar Tumgoren"""
-__email__ = 'stumgoren@ap.org'
-__version__ = '0.2.0'
-
-from .commands.init import Init
-from .commands.push import Push
-from .commands.pull import Pull

datakit-data-0.2.0/datakit_data.egg-info/PKG-INFO

@@ -1,32 +0,0 @@
-Metadata-Version: 1.1
-Name: datakit-data
-Version: 0.2.0
-Summary: A datakit plugin to manage data assets on AWS S3.
-Home-page: https://github.com/associatedpress/datakit-data
-Author: Serdar Tumgoren
-Author-email: stumgoren@ap.org
-License: ISC license
-Description-Content-Type: UNKNOWN
-Description: 
-        
-        datakit-data
-        ---------------
-        
-        A `datakit <https://pypi.python.org/pypi/datakit-core/>`_ plugin to simplify use of
-        Amazon S3 as a data store for data science projects.
-        
-        * `Code <https://github.com/associatedpress/datakit-data>`_
-        * `Docs <http://datakit-data.readthedocs.io/en/latest/>`_
-        
-        
-Keywords: datakit
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: ISC License (ISCL)
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5

datakit-data-0.2.0/datakit_data.egg-info/SOURCES.txt

@@ -1,55 +0,0 @@
-AUTHORS.rst
-CONTRIBUTING.rst
-HISTORY.rst
-LICENSE
-MANIFEST.in
-README.rst
-setup.cfg
-setup.py
-datakit_data/__init__.py
-datakit_data/extra_flags.py
-datakit_data/project_mixin.py
-datakit_data/s3.py
-datakit_data.egg-info/PKG-INFO
-datakit_data.egg-info/SOURCES.txt
-datakit_data.egg-info/dependency_links.txt
-datakit_data.egg-info/entry_points.txt
-datakit_data.egg-info/not-zip-safe
-datakit_data.egg-info/requires.txt
-datakit_data.egg-info/top_level.txt
-datakit_data/commands/__init__.py
-datakit_data/commands/init.py
-datakit_data/commands/pull.py
-datakit_data/commands/push.py
-docs/Makefile
-docs/authors.rst
-docs/conf.py
-docs/contributing.rst
-docs/credits.rst
-docs/datakit_data.commands.rst
-docs/datakit_data.rst
-docs/history.rst
-docs/index.rst
-docs/installation.rst
-docs/make.bat
-docs/modules.rst
-docs/quickstart.rst
-docs/readme.rst
-docs/usage.rst
-docs/_build/html/_static/ajax-loader.gif
-docs/_build/html/_static/comment-bright.png
-docs/_build/html/_static/comment-close.png
-docs/_build/html/_static/comment.png
-docs/_build/html/_static/down-pressed.png
-docs/_build/html/_static/down.png
-docs/_build/html/_static/file.png
-docs/_build/html/_static/minus.png
-docs/_build/html/_static/plus.png
-docs/_build/html/_static/up-pressed.png
-docs/_build/html/_static/up.png
-tests/conftest.py
-tests/test_extra_flags.py
-tests/test_s3.py
-tests/commands/test_init.py
-tests/commands/test_pull.py
-tests/commands/test_push.py

datakit-data-0.2.0/datakit_data.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

datakit-data-0.2.0/datakit_data.egg-info/entry_points.txt

@@ -1,5 +0,0 @@
-[datakit.plugins]
-data init = datakit_data:Init
-data pull = datakit_data:Pull
-data push = datakit_data:Push
-

datakit-data-0.2.0/datakit_data.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

datakit-data-0.2.0/datakit_data.egg-info/requires.txt

@@ -1,3 +0,0 @@
-awscli
-cliff
-datakit-core>=0.2.1

datakit-data-0.2.0/datakit_data.egg-info/top_level.txt

@@ -1 +0,0 @@
-datakit_data