pylunar 0.7.0__tar.gz → 0.7.2__tar.gz

pylunar-0.7.2/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.11
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        args: [--strict]
+        additional_dependencies: [types-pytz==2024.1.0.20240203]
+
+  - repo: https://github.com/numpy/numpydoc
+    rev: v1.6.0
+    hooks:
+      - id: numpydoc-validation
+
+  - repo: https://github.com/tox-dev/tox-ini-fmt
+    rev: "1.3.1"
+    hooks:
+      - id: tox-ini-fmt

{pylunar-0.7.0 → pylunar-0.7.2}/CONTRIBUTING.rst

@@ -3,7 +3,7 @@ Contributing
 ============
 
 Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given. 
+little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
@@ -36,7 +36,7 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-Python Lunar could always use more documentation, whether as part of the 
+Python Lunar could always use more documentation, whether as part of the
 official Python Lunar docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
@@ -58,45 +58,48 @@ Get Started!
 Ready to contribute? Here's how to set up `pylunar` for
 local development.
 
-1. Fork the `pylunar` repo on GitHub.
-2. Clone your fork locally::
+#. Fork the `pylunar` repo on GitHub.
+#. Create a vitrual environment for dependency installation.
+#. Clone your fork locally::
 
     $ git clone git@github.com:your_name_here/pylunar.git
 
-3. Create a branch for local development::
+#. Install the dependencies for development and pre-commit hook::
+
+    $ make init
+
+#. Create a branch for local development::
 
     $ git checkout -b name-of-your-bugfix-or-feature
 
 Now you can make your changes locally.
 
-4. When you're done making changes, check that your changes pass style and unit
-   tests, including testing other Python versions with tox::
+#. When you're done making changes, check that your changes pass style and unit
+   tests::
 
     $ tox
 
-To get tox, just pip install it.
-
-5. Commit your changes and push your branch to GitHub::
+#. Commit your changes (this will cause the pre-commit hook to run) 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
 
-6. Submit a pull request through the GitHub website.
+#. 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
+#. The pull request should include tests.
+#. 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 2.7, and 3.5, and for PyPy.
-   Check https://travis-ci.org/mareuter/pylunar 
-   under pull requests for active pull requests or run the ``tox`` command and
-   make sure that the tests pass for all supported Python versions.
+   feature to the list in HISTORY.rst.
+#. The pull request should work for the supported range of Python versions.
+   The pull request will run GitHub actions to perform those checks.
+   Check https://github.com/mareuter/pylunar/pulls
+   for active pull requests and make sure that the checks all passed.
 
 
 Tips
@@ -104,4 +107,4 @@ Tips
 
 To run a subset of tests::
 
-	 $ py.test test/test_pylunar.py
+	 $ pytest test/test_pylunar.py

{pylunar-0.7.0 → pylunar-0.7.2}/HISTORY.rst

@@ -3,6 +3,24 @@
 History
 -------
 
+0.7.2 (2024-02-26)
+++++++++++++++++++
+
+* Change types module to pkg_types to avoid shadowing builtin
+
+0.7.1 (2024-02-11)
+++++++++++++++++++
+
+* Drop support for Python 3.6 and 3.7
+* Add Python 3.9, 3.10, 3.11 and 3.12 support
+* Switch to pyproject.toml
+* Internal package updates
+* Update docs infrastructure
+* Switch back to tox
+* Add linting and formatting
+* Add mypy and typing
+* Add numpydoc and tox.ini checking
+
 0.7.0 (2023-12-31)
 ++++++++++++++++++
 

{pylunar-0.7.0 → pylunar-0.7.2}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016-2020 Michael Reuter
+Copyright 2016-2024 Michael Reuter
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

pylunar-0.7.2/MANIFEST.in

@@ -0,0 +1,8 @@
+graft docs
+graft scripts
+graft src
+graft tests
+
+global-exclude *~ *.py[cod]
+exclude .readthedocs.yaml .gitignore
+recursive-exclude .github *.yaml

pylunar-0.7.2/Makefile

@@ -0,0 +1,62 @@
+.PHONY: help init clean-pyc clean-build clean-docs clean lint test coverage docs docs-local release check-build
+
+help:
+	@echo "init - initialize a clean clone"
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean-docs - remove doc build artifacts"
+	@echo "clean - remove all artifacts"
+	@echo "lint - check style with ruff"
+	@echo "test - run tests quickly with the default Python"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "docs-local - generate docs and open locally"
+	@echo "release - package and upload a release"
+	@echo "check-build - check distribution packaging"
+
+init:
+	pip install --editable .[dev]
+	pre-commit install
+
+clean: clean-build clean-docs clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr src/*.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+clean-docs:
+	rm -fr docs/api
+	$(MAKE) -C docs clean
+
+lint:
+	tox -e lint
+
+test:
+	pytest -v --doctest-glob=docs/usage.rst
+
+coverage:
+	coverage run -m pytest
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs: clean-docs
+	sphinx-apidoc -fMeT -o docs/api src/pylunar
+	$(MAKE) -C docs html
+
+docs-local: docs
+	open docs/_build/html/index.html
+
+release: clean
+	python -m build
+	twine upload dist/*
+
+check-build: clean
+	python -m build
+	twine check dist/*

pylunar-0.7.2/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: pylunar
+Version: 0.7.2
+Summary: Information for completing the Astronomical League's Lunar and Lunar II observing programs.
+Author-email: Michael Reuter <mareuternh@gmail.com>
+Project-URL: Documentation, http://pylunar.readthedocs.io
+Project-URL: Repository, https://github.com/mareuter/pylunar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: ephem==4.1.5
+Requires-Dist: importlib-resources==6.1.1; python_version < "3.10"
+Requires-Dist: typing-extensions==4.9.0; python_version < "3.10"
+Requires-Dist: pytz==2024.1
+Provides-Extra: dev
+Requires-Dist: pylunar[build,docs,lint,test]; extra == "dev"
+Requires-Dist: tox==4.11.4; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage[toml]==7.4.0; extra == "test"
+Requires-Dist: pytest==7.4.4; extra == "test"
+Provides-Extra: lint
+Requires-Dist: pre-commit~=3.5.0; extra == "lint"
+Provides-Extra: build
+Requires-Dist: build==1.0.3; extra == "build"
+Requires-Dist: twine==4.0.2; extra == "build"
+Provides-Extra: docs
+Requires-Dist: sphinx~=7.1; extra == "docs"
+Requires-Dist: sphinx_rtd_theme==2.0.0; extra == "docs"
+
+=============================
+Python Lunar
+=============================
+
+.. |license| image:: https://img.shields.io/pypi/l/pylunar.svg
+   :target: http://opensource.org/licenses/BSD
+   :alt: BSD License
+
+.. |version| image:: http://img.shields.io/pypi/v/pylunar.svg
+   :target: https://pypi.python.org/pypi/pylunar
+   :alt: Software Version
+
+.. |github| image:: https://github.com/mareuter/pylunar/actions/workflows/ci.yaml/badge.svg
+  :target: https://github.com/mareuter/pylunar
+  :alt: Github build status
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/pylunar.svg
+  :target: https://pypi.python.org/pypi/pylunar
+  :alt: Supported Python
+
+.. |docs| image:: https://readthedocs.org/projects/pylunar/badge/?version=latest
+  :target: https://pylunar.readthedocs.io
+  :alt: Readthedocs status
+
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+  :target: https://github.com/pre-commit/pre-commit
+  :alt: Uses pre-commit
+
+|license| |python| |version| |github| |docs| |pre-commit|
+
+Information for completing the Astronomical League's Lunar and Lunar II observing programs. Uses the `pyephem <https://rhodesmill.org/pyephem>`_ package to calculate lunar information.
+
+
+Features
+--------
+
+* Offer moon information based on location and date/time.
+* Offer lunar targets for AL observing clubs based on terminator location.
+

{pylunar-0.7.0 → pylunar-0.7.2}/README.rst

@@ -10,7 +10,7 @@ Python Lunar
    :target: https://pypi.python.org/pypi/pylunar
    :alt: Software Version
 
-.. |github| image:: https://github.com/mareuter/pylunar/actions/workflows/pythonpackage.yml/badge.svg
+.. |github| image:: https://github.com/mareuter/pylunar/actions/workflows/ci.yaml/badge.svg
   :target: https://github.com/mareuter/pylunar
   :alt: Github build status
 
@@ -22,13 +22,18 @@ Python Lunar
   :target: https://pylunar.readthedocs.io
   :alt: Readthedocs status
 
-|license| |python| |version| |github| |docs|
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+  :target: https://github.com/pre-commit/pre-commit
+  :alt: Uses pre-commit
 
-Information for completing the Astronomical League's Lunar and Lunar II observing programs.
+|license| |python| |version| |github| |docs| |pre-commit|
+
+Information for completing the Astronomical League's Lunar and Lunar II observing programs. Uses the `pyephem <https://rhodesmill.org/pyephem>`_ package to calculate lunar information.
 
 
 Features
 --------
 
 * Offer moon information based on location and date/time.
+* Offer lunar targets for AL observing clubs based on terminator location.
 

pylunar-0.7.2/docs/conf.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+#
+# complexity documentation build configuration file, created by
+# sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+from __future__ import annotations
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+cwd = os.getcwd()
+parent = os.path.dirname(cwd)
+sys.path.insert(0, parent)
+
+import pylunar
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
+              'sphinx.ext.napoleon', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Python Lunar'
+copyright = u'2016-2024, Michael Reuter'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = pylunar.__version__
+# The full version, including alpha/beta/rc tags.
+release = pylunar.__version__
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pylunardoc'
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'pylunar.tex', u'Python Lunar Documentation',
+   u'Michael Reuter', 'manual'),
+]
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'pylunar', u'Python Lunar Documentation',
+     [u'Michael Reuter'], 1)
+]
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'pylunar', u'Python Lunar Documentation',
+   u'Michael Reuter', 'pylunar',
+   'Information for completing the Astronomical League\'s Lunar and Lunar II observing programs..',
+   'Miscellaneous'),
+]

{pylunar-0.7.0 → pylunar-0.7.2}/docs/index.rst

@@ -16,6 +16,7 @@ Contents:
    contributing
    authors
    history
+   api/pylunar
 
 Feedback
 ========

pylunar-0.7.2/pyproject.toml

@@ -0,0 +1,122 @@
+[build-system]
+requires = [
+    "setuptools>=64",
+    "setuptools_scm>=8",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+dynamic = ["version"]
+name = "pylunar"
+authors = [
+    {name = "Michael Reuter", email = "mareuternh@gmail.com"}
+]
+description = "Information for completing the Astronomical League's Lunar and Lunar II observing programs."
+readme = "README.rst"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "ephem==4.1.5",
+    "importlib-resources==6.1.1;python_version<'3.10'",
+    "typing-extensions==4.9.0;python_version<'3.10'",
+    "pytz==2024.1"
+]
+
+[project.urls]
+Documentation = "http://pylunar.readthedocs.io"
+Repository = "https://github.com/mareuter/pylunar"
+
+[project.optional-dependencies]
+dev = [
+    "pylunar[build,docs,lint,test]",
+    "tox==4.11.4"
+]
+test = [
+    "coverage[toml]==7.4.0",
+    "pytest==7.4.4",
+]
+lint = [
+    "pre-commit~=3.5.0"
+]
+build = [
+    "build==1.0.3",
+    "twine==4.0.2"
+]
+docs = [
+    "sphinx~=7.1",
+    "sphinx_rtd_theme==2.0.0"
+]
+
+[tool.setuptools_scm]
+
+[tool.ruff]
+exclude = [
+    "docs/**",
+    "scripts/startup.py"
+
+]
+ignore = [
+    "D104"
+]
+line-length = 110
+select = [
+    "B",
+    "D",
+    "E",
+    "F",
+    "I",
+    "SIM",
+    "UP",
+    "W"
+]
+
+[tool.ruff.per-file-ignores]
+"src/pylunar/__init__.py" = [
+    "E402",
+    "F401",
+    "F403"
+]
+"tests/**" = [
+    "D101",
+    "D102",
+    "D103",
+]
+
+[tool.ruff.isort]
+force-sort-within-sections = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 79
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.numpydoc_validation]
+checks = [
+    "all",   # report on all checks, except the below
+    "EX01",
+    "SA01",
+    "ES01",
+    "GL01",
+    "SS05"
+]
+exclude = [
+    "test_*",
+    "__init__",
+    "conf",
+    "startup"
+]

pylunar-0.7.0/pylunar/__init__.py → pylunar-0.7.2/scripts/startup.py

@@ -8,11 +8,8 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
-__author__ = 'Michael Reuter'
-__email__ = 'mareuternh@gmail.com'
-__version__ = '0.7.0'
-
-from .helpers import *
-from .lunar_feature import LunarFeature
-from .lunar_feature_container import LunarFeatureContainer
-from .moon_info import MoonInfo
+from pylunar import MoonInfo
+location = ((35, 58, 10), (-84, 19, 0))
+obs_datetime = (2013, 10, 18, 22, 0, 0)
+mi = MoonInfo(location[0], location[1])
+mi.update(obs_datetime)

pylunar-0.7.2/setup.cfg

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

pylunar-0.7.2/src/pylunar/__init__.py

@@ -0,0 +1,42 @@
+# This file is part of pylunar.
+#
+# Developed by Michael Reuter.
+#
+# See the LICENSE file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# Use of this source code is governed by a 3-clause BSD-style
+# license that can be found in the LICENSE file.
+
+__all__ = [
+    "__author__",
+    "__email__",
+    "__version__",
+    "LunarFeature",
+    "LunarFeatureContainer",
+    "mjd_to_date_tuple",
+    "MoonInfo",
+    "tuple_to_string",
+    "version_info",
+]
+
+from importlib.metadata import PackageNotFoundError, version
+
+__author__ = "Michael Reuter"
+__email__ = "mareuternh@gmail.com"
+try:
+    __version__ = version("pylunar")
+except PackageNotFoundError:
+    # package is not installed
+    __version__ = "0.0.0"
+
+version_info = __version__.split(".")
+"""The decomposed version, split across "``.``."
+
+Use this for version comparison.
+"""
+
+from .helpers import mjd_to_date_tuple, tuple_to_string
+from .lunar_feature import LunarFeature
+from .lunar_feature_container import LunarFeatureContainer
+from .moon_info import MoonInfo

{pylunar-0.7.0 → pylunar-0.7.2/src}/pylunar/helpers.py

@@ -8,13 +8,18 @@
 # Use of this source code is governed by a 3-clause BSD-style
 # license that can be found in the LICENSE file.
 
-"""Module for helper functions.
-"""
+"""Module for helper functions."""
+
+from __future__ import annotations
+
+__all__ = ["mjd_to_date_tuple", "tuple_to_string"]
 
 import ephem
 
+from .pkg_types import DateTimeTuple, DmsCoordinate
+
 
-def mjd_to_date_tuple(mjd, round_off=False):
+def mjd_to_date_tuple(mjd: float, round_off: bool = False) -> DateTimeTuple:
     """Convert a Modified Julian date to a UTC time tuple.
 
     Parameters
@@ -29,13 +34,12 @@ def mjd_to_date_tuple(mjd, round_off=False):
     tuple
         The UTC time for the MJD.
     """
-    if round_off:
-        return tuple(int(x) for x in ephem.Date(mjd).tuple())
-    else:
-        return ephem.Date(mjd).tuple()
+    date_tuple: DateTimeTuple
+    date_tuple = tuple(int(x) for x in ephem.Date(mjd).tuple()) if round_off else ephem.Date(mjd).tuple()
+    return date_tuple
 
 
-def tuple_to_string(coord):
+def tuple_to_string(coord: DmsCoordinate) -> str:
     """Return a colon-delimited string.
 
     Parameters