recalling-machine 0.0.1__tar.gz

recalling_machine-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alexander Fedotov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

recalling_machine-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+include src/recalling_machine/*.yaml

recalling_machine-0.0.1/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: recalling-machine
+Version: 0.0.1
+Summary: A Machine that recalls what was memorized.
+Author-email: Alexander Fedotov <alex.fedotov@aol.com>
+Project-URL: Homepage, https://github.com/recalling-machine/recalling-machine
+Project-URL: Bug Tracker, https://github.com/recalling-machine/recalling-machine/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyGithub>=2.3.0
+Requires-Dist: PyYAML>=6.0.1
+
+# recalling-machine
+A Machine that recalls what was memorized.
+<pre>
+  pip install recalling-machine
+</pre>
+Then:
+```Python
+  # Python
+  import recalling_machine
+```

recalling_machine-0.0.1/README.md

@@ -0,0 +1,10 @@
+# recalling-machine
+A Machine that recalls what was memorized.
+<pre>
+  pip install recalling-machine
+</pre>
+Then:
+```Python
+  # Python
+  import recalling_machine
+```

recalling_machine-0.0.1/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=67.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project]
+name = "recalling-machine"
+version = "0.0.1"
+authors = [
+    {name="Alexander Fedotov", email="alex.fedotov@aol.com"},
+]
+description = "A Machine that recalls what was memorized."
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+]
+dependencies = [
+    "PyGithub >= 2.3.0",
+    "PyYAML >= 6.0.1"
+]
+[project.urls]
+"Homepage" = "https://github.com/recalling-machine/recalling-machine"
+"Bug Tracker" = "https://github.com/recalling-machine/recalling-machine/issues"

recalling_machine-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

recalling_machine-0.0.1/src/recalling_machine/__init__.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Python
+
+"""Copyright (c) Alexander Fedotov.
+This source code is licensed under the license found in the
+LICENSE file in the root directory of this source tree.
+"""
+import os
+from . import githf
+import yaml
+
+
+MACHINE_ORGANIZATION_NAME = 'recalling-machine'  # or other organization
+PRIVATE_REPO_WITH_TEXT = 'recalling_machine'
+
+try:
+    gh = githf.connectto_repo(organization=MACHINE_ORGANIZATION_NAME,
+                              repository_name=PRIVATE_REPO_WITH_TEXT,
+                              private=True)
+    MACHINE_YAML = githf.read_file(repository=gh, file_path='machina.yaml')
+
+except Exception as e:
+    machina_path = os.path.join(os.path.dirname(__file__), 'machina.yaml')
+    with open(machina_path, 'r') as yaml_file:
+        MACHINE_YAML = yaml_file.read()
+
+RECALLING_MACHINE = yaml.load(MACHINE_YAML, Loader=yaml.FullLoader)

recalling_machine-0.0.1/src/recalling_machine/githf.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# Python
+
+"""Copyright (c) Alexander Fedotov.
+This source code is licensed under the license found in the
+LICENSE file in the root directory of this source tree.
+"""
+from os import environ
+from github import Github, UnknownObjectException
+from urllib3 import disable_warnings
+
+
+github_token    = environ.get('GITHUB_TOKEN', '')
+github_name     = environ.get('GITHUB_NAME', '')
+github_email    = environ.get('GITHUB_EMAIL', '')
+
+# The useless urllib3 warning is too maddening for an ordinary human being.
+disable_warnings()
+
+
+# Repo
+def connectto_repo(organization=None,
+                   repository_name=None,
+                   private=False):
+    """
+    Establish connection with a repository.
+    Return 'None' if connection fails.
+    """
+    gh = Github(github_token, verify=False)
+    if organization:
+        org = gh.get_organization(organization)
+        try:
+            repo = org.get_repo(f'{repository_name}')
+        except UnknownObjectException:
+            # print('Can not connect YOU to this repo in this organization')
+            repo = None
+        return repo
+    else:
+        user = gh.get_user()
+        try:
+            repo = user.get_repo(repository_name)
+        except UnknownObjectException:
+            # print('Can not connect YOU to this repo')
+            repo = None
+        return repo
+
+
+def read_file(repository,
+              file_path):
+    """ Read a file in a repository
+        file_path: path to the file formatted as
+        'directory_in_repo/subdirectory/file.ext'
+    """
+    try:
+        # Get the file if it exists
+        ingested_file = repository.get_contents(file_path)
+        content = ingested_file.decoded_content.decode("utf-8")
+
+    except UnknownObjectException:
+        # The file doesn't exist
+        # print('The file does not exist')
+        content = ''
+
+    return content

recalling_machine-0.0.1/src/recalling_machine/machina.yaml

@@ -0,0 +1,2 @@
+name: recalling-machine
+description: A machine that recalls what was memorized.

recalling_machine-0.0.1/src/recalling_machine.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: recalling-machine
+Version: 0.0.1
+Summary: A Machine that recalls what was memorized.
+Author-email: Alexander Fedotov <alex.fedotov@aol.com>
+Project-URL: Homepage, https://github.com/recalling-machine/recalling-machine
+Project-URL: Bug Tracker, https://github.com/recalling-machine/recalling-machine/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyGithub>=2.3.0
+Requires-Dist: PyYAML>=6.0.1
+
+# recalling-machine
+A Machine that recalls what was memorized.
+<pre>
+  pip install recalling-machine
+</pre>
+Then:
+```Python
+  # Python
+  import recalling_machine
+```

recalling_machine-0.0.1/src/recalling_machine.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/recalling_machine/__init__.py
+src/recalling_machine/githf.py
+src/recalling_machine/machina.yaml
+src/recalling_machine.egg-info/PKG-INFO
+src/recalling_machine.egg-info/SOURCES.txt
+src/recalling_machine.egg-info/dependency_links.txt
+src/recalling_machine.egg-info/requires.txt
+src/recalling_machine.egg-info/top_level.txt

recalling_machine-0.0.1/src/recalling_machine.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

recalling_machine-0.0.1/src/recalling_machine.egg-info/requires.txt

@@ -0,0 +1,2 @@
+PyGithub>=2.3.0
+PyYAML>=6.0.1

recalling_machine-0.0.1/src/recalling_machine.egg-info/top_level.txt

@@ -0,0 +1 @@
+recalling_machine