Skip to content

Commit

Permalink
rename to stratage
Browse files Browse the repository at this point in the history
  • Loading branch information
sarttiso committed Sep 30, 2024
1 parent beed4ea commit 400d7e8
Show file tree
Hide file tree
Showing 13 changed files with 77 additions and 228 deletions.
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# .coveragerc to control coverage.py
[run]
branch = True
source = stratagemc
source = stratage
# omit = bad_file.py

[paths]
Expand Down
26 changes: 13 additions & 13 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
Contributing
============

Welcome to ``stratagemc`` contributor's guide.
Welcome to ``stratage`` contributor's guide.

This document focuses on getting any potential contributor familiarized
with the development processes, but `other kinds of contributions`_ are also
Expand All @@ -46,7 +46,7 @@ guidelines.
Issue Reports
=============

If you experience bugs or general issues with ``stratagemc``, please have a look
If you experience bugs or general issues with ``stratage``, please have a look
on the `issue tracker`_. If you don't see anything useful there, please feel
free to fire an issue report.

Expand All @@ -65,10 +65,10 @@ you help us to identify the root cause of the issue.
Documentation Improvements
==========================

You can help improve ``stratagemc`` docs by making them more readable and coherent, or
You can help improve ``stratage`` docs by making them more readable and coherent, or
by adding missing information and correcting mistakes.

``stratagemc`` documentation uses Sphinx_ as its main documentation compiler.
``stratage`` documentation uses Sphinx_ as its main documentation compiler.
This means that the docs are kept in the same repository as the project code, and
that any documentation update is done in the same way was a code contribution.

Expand All @@ -80,7 +80,7 @@ that any documentation update is done in the same way was a code contribution.

.. tip::
Please notice that the `GitHub web interface`_ provides a quick way of
propose changes in ``stratagemc``'s files. While this mechanism can
propose changes in ``stratage``'s files. While this mechanism can
be tricky for normal code contributions, it works perfectly fine for
contributing to the docs, and can be quite handy.

Expand Down Expand Up @@ -131,8 +131,8 @@ This can easily be done via either |virtualenv|_::

or Miniconda_::

conda create -n stratagemc python=3 six virtualenv pytest pytest-cov
conda activate stratagemc
conda create -n stratage python=3 six virtualenv pytest pytest-cov
conda activate stratage

Clone the repository
--------------------
Expand All @@ -142,8 +142,8 @@ Clone the repository
page. This creates a copy of the code under your account on |the repository service|.
#. Clone this copy to your local disk::

git clone git@github.com:YourLogin/stratagemc.git
cd stratagemc
git clone git@github.com:YourLogin/stratage.git
cd stratage

#. You should run::

Expand All @@ -158,7 +158,7 @@ Clone the repository
pip install pre-commit
pre-commit install

``stratagemc`` comes with a lot of hooks configured to automatically help the
``stratage`` comes with a lot of hooks configured to automatically help the
developer to check the code being written.

Implement your changes
Expand Down Expand Up @@ -285,7 +285,7 @@ Releases

If you are part of the group of maintainers and have correct user permissions
on PyPI_, the following steps can be used to release a new version for
``stratagemc``:
``stratage``:

#. Make sure all unit tests are successful.
#. Tag the current commit on the main branch with a release tag, e.g., ``v1.2.3``.
Expand Down Expand Up @@ -314,8 +314,8 @@ on PyPI_, the following steps can be used to release a new version for
.. |the repository service| replace:: GitHub
.. |contribute button| replace:: "Create pull request"

.. _repository: https://github.com/<USERNAME>/stratagemc
.. _issue tracker: https://github.com/<USERNAME>/stratagemc/issues
.. _repository: https://github.com/<USERNAME>/stratage
.. _issue tracker: https://github.com/<USERNAME>/stratage/issues
.. <-- end -->
Expand Down
28 changes: 14 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
.. These are examples of badges you might want to add to your README:
please update the URLs accordingly
.. image:: https://api.cirrus-ci.com/github/<USER>/stratagemc.svg?branch=main
.. image:: https://api.cirrus-ci.com/github/<USER>/stratage.svg?branch=main
:alt: Built Status
:target: https://cirrus-ci.com/github/<USER>/stratagemc
.. image:: https://readthedocs.org/projects/stratagemc/badge/?version=latest
:target: https://cirrus-ci.com/github/<USER>/stratage
.. image:: https://readthedocs.org/projects/stratage/badge/?version=latest
:alt: ReadTheDocs
:target: https://stratagemc.readthedocs.io/en/stable/
.. image:: https://img.shields.io/coveralls/github/<USER>/stratagemc/main.svg
:target: https://stratage.readthedocs.io/en/stable/
.. image:: https://img.shields.io/coveralls/github/<USER>/stratage/main.svg
:alt: Coveralls
:target: https://coveralls.io/r/<USER>/stratagemc
.. image:: https://img.shields.io/pypi/v/stratagemc.svg
:target: https://coveralls.io/r/<USER>/stratage
.. image:: https://img.shields.io/pypi/v/stratage.svg
:alt: PyPI-Server
:target: https://pypi.org/project/stratagemc/
.. image:: https://img.shields.io/conda/vn/conda-forge/stratagemc.svg
:target: https://pypi.org/project/stratage/
.. image:: https://img.shields.io/conda/vn/conda-forge/stratage.svg
:alt: Conda-Forge
:target: https://anaconda.org/conda-forge/stratagemc
.. image:: https://pepy.tech/badge/stratagemc/month
:target: https://anaconda.org/conda-forge/stratage
.. image:: https://pepy.tech/badge/stratage/month
:alt: Monthly Downloads
:target: https://pepy.tech/project/stratagemc
:target: https://pepy.tech/project/stratage
.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
:alt: Twitter
:target: https://twitter.com/stratagemc
:target: https://twitter.com/stratage
.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
:alt: Project generated with PyScaffold
Expand All @@ -30,7 +30,7 @@
|
==========
stratagemc
stratage
==========


Expand Down
48 changes: 24 additions & 24 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,31 +28,31 @@
# setup.py install" in the RTD Advanced Settings.
# Additionally it helps us to avoid running apidoc manually

# try: # for Sphinx >= 1.7
# from sphinx.ext import apidoc
# except ImportError:
# from sphinx import apidoc
try: # for Sphinx >= 1.7
from sphinx.ext import apidoc
except ImportError:
from sphinx import apidoc

# output_dir = os.path.join(__location__, "api")
# module_dir = os.path.join(__location__, "../src/stratagemc")
# try:
# shutil.rmtree(output_dir)
# except FileNotFoundError:
# pass
output_dir = os.path.join(__location__, "api")
module_dir = os.path.join(__location__, "../src/stratage")
try:
shutil.rmtree(output_dir)
except FileNotFoundError:
pass

# try:
# import sphinx
try:
import sphinx

# cmd_line = f"sphinx-apidoc --implicit-namespaces -f -o {output_dir} {module_dir}"
cmd_line = f"sphinx-apidoc --implicit-namespaces -f -o {output_dir} {module_dir}"

# args = cmd_line.split(" ")
# if tuple(sphinx.__version__.split(".")) >= ("1", "7"):
# # This is a rudimentary parse_version to avoid external dependencies
# args = args[1:]
args = cmd_line.split(" ")
if tuple(sphinx.__version__.split(".")) >= ("1", "7"):
# This is a rudimentary parse_version to avoid external dependencies
args = args[1:]

# apidoc.main(args)
# except Exception as e:
# print("Running `sphinx-apidoc` failed!\n{}".format(e))
apidoc.main(args)
except Exception as e:
print("Running `sphinx-apidoc` failed!\n{}".format(e))

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -89,7 +89,7 @@
master_doc = "index"

# General information about the project.
project = "stratagemc"
project = "stratage"
copyright = "2024, Adrian Tasistro-Hart"

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -101,7 +101,7 @@
# If you don’t need the separation provided between version and release,
# just set them both to the same value.
try:
from stratagemc import __version__ as version
from stratage import __version__ as version
except ImportError:
version = ""

Expand Down Expand Up @@ -231,7 +231,7 @@
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = "stratagemc-doc"
htmlhelp_basename = "stratage-doc"


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -248,7 +248,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
("index", "user_guide.tex", "stratagemc Documentation", "Adrian Tasistro-Hart", "manual")
("index", "user_guide.tex", "stratage Documentation", "Adrian Tasistro-Hart", "manual")
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
==========
stratagemc
==========
========
StratAge
========

This is the documentation of **stratagemc**.
This is the documentation of **stratage**.

.. note::

Expand Down
6 changes: 3 additions & 3 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
stratagemc
==========
stratage
========

.. toctree::
:maxdepth: 4

stratagemc
stratage
12 changes: 6 additions & 6 deletions docs/stratagemc.rst → docs/stratage.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
stratagemc package
==================
stratage package
================

Module contents
---------------

.. automodule:: stratagemc
.. automodule:: stratage
:imported-members:
:members:
:undoc-members:
Expand All @@ -14,10 +14,10 @@ Module contents
Submodules
----------

stratagemc.geochron module
--------------------------
stratage.geochron module
------------------------

.. automodule:: stratagemc.geochron
.. automodule:: stratage.geochron
:members:
:undoc-members:
:show-inheritance:
Expand Down
18 changes: 9 additions & 9 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@
# https://setuptools.pypa.io/en/latest/references/keywords.html

[metadata]
name = StratAgeMC
name = StratAge
description = Bayesian age modeling of stratigraphy.
author = Adrian Tasistro-Hart
author_email = adrian@tasistro-hart.com
license = GPL-3.0-only
license_files = LICENSE.txt
long_description = file: README.rst
long_description_content_type = text/x-rst; charset=UTF-8
url = https://github.com/sarttiso/stratagemc
url = https://github.com/sarttiso/stratage
# Add here related links, for example:
project_urls =
Documentation = https://pyscaffold.org/
Source = https://github.com/sarttiso/stratagemc
Changelog = https://adrian.tasistro-hart.com/stratagemc/changelog.html
Source = https://github.com/sarttiso/stratage
Changelog = https://adrian.tasistro-hart.com/stratage/changelog.html
# Tracker = https://github.com/pyscaffold/pyscaffold/issues
# Conda-Forge = https://anaconda.org/conda-forge/pyscaffold
# Download = https://pypi.org/project/PyScaffold/#files
Expand Down Expand Up @@ -63,7 +63,7 @@ exclude =

[options.extras_require]
# Add here additional requirements for extra features, to install with:
# `pip install stratagemc[PDF]` like:
# `pip install stratage[PDF]` like:
# PDF = ReportLab; RXP

# Add here test requirements (semicolon/line-separated)
Expand All @@ -75,10 +75,10 @@ testing =
[options.entry_points]
# Add here console scripts like:
# console_scripts =
# script_name = stratagemc.module:function
# script_name = stratage.module:function
# For example:
# console_scripts =
# fibonacci = stratagemc.skeleton:run
# fibonacci = stratage.skeleton:run
# And any other entry points, for example:
# pyscaffold.cli =
# awesome = pyscaffoldext.awesome.extension:AwesomeExtension
Expand All @@ -90,7 +90,7 @@ testing =
# CAUTION: --cov flags may prohibit setting breakpoints while debugging.
# Comment those flags to avoid this pytest issue.
addopts =
--cov stratagemc --cov-report term-missing
--cov stratage --cov-report term-missing
--verbose
norecursedirs =
dist
Expand Down Expand Up @@ -125,4 +125,4 @@ exclude =
# PyScaffold's parameters when the project was created.
# This will be used when updating. Do not change!
version = 4.5
package = stratagemc
package = stratage
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Setup file for stratagemc.
Setup file for stratage.
Use setup.cfg to configure your project.
This file was generated with PyScaffold 4.5.
Expand Down
2 changes: 1 addition & 1 deletion src/stratagemc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
finally:
del version, PackageNotFoundError

from .stratagemc import *
from .stratage import *

__all__ = ['geochron_height_check',
'trim_units',
Expand Down
Loading

0 comments on commit 400d7e8

Please sign in to comment.