first commit

.github/workflows/test_and_release.yaml

@@ -0,0 +1,58 @@
+name: test_and_release
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  create_tag:
+    permissions:
+      contents: write
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+
+    name: A job to test the functionalities of the code
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Installing Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Installing this repo as a Python package
+      run: |
+        python3 -m pip install ${{ github.workspace }}
+
+    - name: Installing GitHubApiHelper
+      run: |
+        python3 -m pip install git+https://github.com/zhenghaven/[email protected]
+
+    - name: Get latest version
+      id: latest_ver
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        python3 -m GitHubApiHelper --auth-token \
+          api_tags_latest_ver \
+            --repo ${{ github.repository }} \
+            -l $(python3 -m zyAPI --version) \
+            --github-out
+
+    - name: Create tag
+      if: ${{ startsWith(github.ref, 'refs/heads/main') && steps.latest_ver.outputs.remote != steps.latest_ver.outputs.all }}
+      uses: actions/github-script@v6
+      with:
+        script: |
+          github.rest.git.createRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: 'refs/tags/${{ steps.latest_ver.outputs.allV }}',
+            sha: context.sha
+          })

.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+build/
+.DS_Store/

setup.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+# -*- coding:utf-8 -*-
+###
+# Copyright (c) 2024 Haofan Zheng
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+###
+
+
+
+from setuptools import setup
+from setuptools import find_packages
+
+import zyAPI._Meta
+
+
+setup(
+	name        = zyAPI._Meta.PKG_NAME,
+	version     = zyAPI._Meta.__version__,
+	packages    = find_packages(where='.', exclude=['setup.py']),
+	url         = 'https://github.com/lsd-ucsc/zyAPI',
+	license     = zyAPI._Meta.PKG_LICENSE,
+	author      = zyAPI._Meta.PKG_AUTHOR,
+	description = zyAPI._Meta.PKG_DESCRIPTION,
+	entry_points= {
+		'console_scripts': [
+			'zyAPI=zyAPI.__main__:main',
+		]
+	},
+	install_requires=[
+		'requests==2.31.0',
+		'pandas==2.2.1',
+		'numpy==1.26.4',
+	],
+)

zyAPI/Auth/Auth.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+# -*- coding:utf-8 -*-
+###
+# Copyright (c) 2024 Haofan Zheng
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+###
+
+
+class Auth(object):
+
+	def __init__(self) -> None:
+		super(Auth, self).__init__()
+
+	def AddAuth(self, headers: dict) -> None:
+		raise NotImplementedError('AddAuth not implemented')

zyAPI/Auth/Token.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+# -*- coding:utf-8 -*-
+###
+# Copyright (c) 2024 Haofan Zheng
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+###
+
+
+from . import Auth
+
+
+class Token(Auth.Auth):
+
+	@classmethod
+	def FromFile(cls, path: str) -> 'Token':
+		with open(path, 'r') as f:
+			token = f.read().strip()
+		return cls(token)
+
+	def __init__(self, token: str) -> None:
+		super(Token, self).__init__()
+
+		self.token = token
+
+	def AddAuth(self, headers: dict) -> None:
+		headers['Authorization'] = f'Bearer {self.token}'
+

zyAPI/Auth/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+# -*- coding:utf-8 -*-
+###
+# Copyright (c) 2024 Haofan Zheng
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+###
+
+

zyAPI/Due/Datetime.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding:utf-8 -*-
+###
+# Copyright (c) 2024 Haofan Zheng
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+###
+
+
+import datetime
+
+try:
+	import zoneinfo
+except ImportError:
+	from backports import zoneinfo
+
+
+class Datetime(object):
+
+	def __init__(self, datetime: datetime.datetime) -> None:
+		super(Datetime, self).__init__()
+
+		self.datetime = datetime
+
+	def GetTimestampStr(self) -> str:
+		# format: '2024-03-08T07:59:59.999Z'
+		return self.datetime.strftime('%Y-%m-%dT%H:%M:%S.%fZ')
+
+	def GetUtcTimestampStr(self) -> str:
+		utcDatetime = self.datetime.astimezone(zoneinfo.ZoneInfo('UTC'))
+		return utcDatetime.strftime('%Y-%m-%dT%H:%M:%S.%fZ')
+
+	def GetTimezoneAbbr(self) -> str:
+		return self.datetime.strftime('%Z')
+
+	def GetTimezoneOffsetMin(self) -> int:
+		return int(self.datetime.utcoffset().total_seconds()) // 60
+
+	def GetZyTimezoneOffsetMin(self) -> int:
+		return -1 * self.GetTimezoneOffsetMin()
+
+	def GetReportNameSuffix(self) -> str:
+		# report_2024-01-20_0759_PST
+		return self.datetime.strftime('%Y-%m-%d_%H%M_%Z')
+
+	def __str__(self) -> str:
+		return (
+			f'{self.__class__.__name__}' +
+			f'(ts={self.GetTimestampStr()}, ' +
+			f'tz={self.GetTimezoneAbbr()}, ' +
+			f'offset={self.GetTimezoneOffsetMin()})'
+		)
+
+	@classmethod
+	def FromComponents(
+		cls,
+		year: int,
+		month: int,
+		day: int,
+		hour: int,
+		minute: int,
+		second: int,
+		tz: str,
+	) -> 'Datetime':
+		tzInfo = zoneinfo.ZoneInfo(tz)
+
+		return cls(
+			datetime=datetime.datetime(
+				year=year,
+				month=month,
+				day=day,
+				hour=hour,
+				minute=minute,
+				second=second,
+				tzinfo=tzInfo
+			)
+		)
+