Skip to content
Merged

Dev #23

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.11'

- name: Install dependencies
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.11'

- name: Install build dependencies
run: |
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

[Read the Docs](https://talbotknighton.github.io/trendify/)

[View on PyPi](https://pypi.org/project/trendify/)

[View on GitHub](https://github.com/TalbotKnighton/trendify)
[![PyPI version](https://img.shields.io/pypi/v/trendify.svg)](https://pypi.org/project/trendify/)
[![Python versions](https://img.shields.io/pypi/pyversions/trendify.svg)](https://pypi.org/project/trendify/)
[![License](https://img.shields.io/github/license/TalbotKnighton/trendify.svg)](https://github.com/TalbotKnighton/trendify/blob/main/LICENSE)
[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://talbotknighton.github.io/trendify/)
[![GitHub](https://img.shields.io/github/stars/TalbotKnighton/trendify?style=social)](https://github.com/TalbotKnighton/trendify)
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ hide:

# Welcome to Trendify


[![PyPI Version](https://img.shields.io/pypi/v/trendify.svg)](https://pypi.org/project/trendify/)
[![Python Versions](https://img.shields.io/pypi/pyversions/trendify.svg)](https://pypi.org/project/trendify/)
[![License](https://img.shields.io/github/license/TalbotKnighton/trendify.svg)](https://github.com/TalbotKnighton/trendify/blob/main/LICENSE)
[![GitHub](https://img.shields.io/github/stars/TalbotKnighton/trendify?style=social)](https://github.com/TalbotKnighton/trendify)


### Description

The `trendify` package makes it easy to compare data from multiple runs of a batch process. The core functionality is to generate CSV tables and JPEG images by mapping a user-provided processing function over a user-provided set of input data directories. Parallelization and data serialization are used to speed up processing time and maintain low memory requirements. `trendify` is run via a terminal [command line interface (CLI)][cli] one-liner method or via a Python application programming interface (API).
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
site_name: Trendify
site_url: https://talbotknighton.github.io/trendify/
repo_url: https://github.com/TalbotKnighton/trendify
repo_name: TalbotKnighton/trendify
site_description: Data visualization for batch processes via data models.
site_author: Talbot Knighton

repo_url: https://github.com/TalbotKnighton/trendify
# edit_uri: blob/master/docs/

theme:
Expand Down
16 changes: 8 additions & 8 deletions publish.sh
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ fi

# Update documentation URL in pyproject.toml to point to the docs site
echo "Updating documentation URL in pyproject.toml..."
sed -i.bak 's|"Documentation" = ".*"|"Documentation" = "https://talbotknighton.github.io/pydantic-discriminated/"|' pyproject.toml
sed -i.bak 's|"Documentation" = ".*"|"Documentation" = "https://talbotknighton.github.io/trendify/"|' pyproject.toml
rm pyproject.toml.bak # Remove backup file

# Check if email in pyproject.toml contains .org and fix it if needed
Expand All @@ -106,8 +106,8 @@ fi
# Update README.md if it contains badge.fury.io badges
if [ -f "README.md" ] && grep -q "badge.fury.io" README.md; then
echo "Updating badges in README.md..."
sed -i.bak 's|https://badge.fury.io/py/pydantic-discriminated.svg|https://img.shields.io/pypi/v/pydantic-discriminated.svg|g' README.md
sed -i.bak 's|https://badge.fury.io/py/pydantic-discriminated|https://pypi.org/project/pydantic-discriminated/|g' README.md
sed -i.bak 's|https://badge.fury.io/py/trendify.svg|https://img.shields.io/pypi/v/trendify.svg|g' README.md
sed -i.bak 's|https://badge.fury.io/py/trendify|https://pypi.org/project/trendify/|g' README.md
rm README.md.bak # Remove backup file
fi

Expand All @@ -119,15 +119,15 @@ if [ -f "docs/index.md" ]; then
echo "Checking badges in docs/index.md..."
if grep -q "badge.fury.io" docs/index.md; then
echo "Updating PyPI badge in docs/index.md..."
sed -i.bak 's|https://badge.fury.io/py/pydantic-discriminated.svg|https://img.shields.io/pypi/v/pydantic-discriminated.svg|g' docs/index.md
sed -i.bak 's|https://badge.fury.io/py/pydantic-discriminated|https://pypi.org/project/pydantic-discriminated/|g' docs/index.md
sed -i.bak 's|https://badge.fury.io/py/trendify.svg|https://img.shields.io/pypi/v/trendify.svg|g' docs/index.md
sed -i.bak 's|https://badge.fury.io/py/trendify|https://pypi.org/project/trendify/|g' docs/index.md
rm docs/index.md.bak # Remove backup file
fi

# Update documentation badge to be more useful (not link to itself)
if grep -q "docs-mkdocs-blue" docs/index.md; then
echo "Updating documentation badge in docs/index.md..."
sed -i.bak 's|[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://talbotknighton.github.io/pydantic-discriminated/)|[![API Reference](https://img.shields.io/badge/api-reference-blue.svg)](https://talbotknighton.github.io/pydantic-discriminated/api-reference/)|g' docs/index.md
sed -i.bak 's|[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://talbotknighton.github.io/trendify/)|[![API Reference](https://img.shields.io/badge/api-reference-blue.svg)](https://talbotknighton.github.io/trendify/api-reference/)|g' docs/index.md
rm docs/index.md.bak # Remove backup file
fi
fi
Expand Down Expand Up @@ -186,7 +186,7 @@ echo "To view the documentation locally, run: mike serve"

# Create pull request from dev to main
echo "Creating a pull request from dev to main..."
echo "Please go to GitHub and create the PR: https://github.com/TalbotKnighton/pydantic-discriminated/compare/main...dev"
echo "Please go to GitHub and create the PR: https://github.com/TalbotKnighton/trendify/compare/main...dev"
echo "After the PR is reviewed and merged, run the following commands:"
echo "git checkout main"
echo "git pull origin main"
Expand Down Expand Up @@ -214,7 +214,7 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
# Wait for the package to be published to PyPI
echo "Waiting for package to be published to PyPI..."
echo "This may take a few minutes. The GitHub Actions workflow should be building and publishing your package."
echo "You can check the progress here: https://github.com/TalbotKnighton/pydantic-discriminated/actions"
echo "You can check the progress here: https://github.com/TalbotKnighton/trendify/actions"

read -p "Has the package been published to PyPI? (y/n) " -n 1 -r
echo
Expand Down
20 changes: 13 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ dependencies = [
"streamlit",
]
name = "trendify"
version = "1.2.3"
version = "1.2.5"
requires-python = ">= 3.11"
authors = [
{ name = "Talbot Knighton", email = "talbotknighton@gmail.com" },
Expand Down Expand Up @@ -72,14 +72,20 @@ dev = [
"pytest",
"pytest-asyncio",
"pytest-cov",
"mike",
"isort>=5.12.0",
"flake8>=6.0.0",
"mkdocs-material>=9.2.0",
"mkdocs-redirects>=1.0.0",
"hatchling>=1.11.0",
]

# [project.urls]
# Homepage = ""
# Documentation = ""
# Repository = ""
# Issues = ""
# Changelog = ""
[project.urls]
"Homepage" = "https://github.com/talbotknighton/trendify"
"Bug Tracker" = "https://github.com/talbotknighton/trendify/issues"
"Documentation" = "https://talbotknighton.github.io/trendify/"
"Source Code" = "https://github.com/talbotknighton/trendify"
"PyPI" = "https://pypi.org/project/trendify/"

[project.scripts]
trendify_make_sample_data = "trendify.examples:make_sample_data"
Expand Down