Skip to content

Update Doc and Version #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cuicaihao merged 7 commits into from
May 4, 2025
Merged

Update Doc and Version #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9501489
Update docs and remove empty folders
cuicaihao May 3, 2025
5e244ed
chore: update workflow to use ubuntu-22.04 instead of ubuntu-20.04
cuicaihao May 3, 2025
80b09c4
🔥 chore: remove unused features, models, and visualization modules
cuicaihao May 3, 2025
6f8987f
fix: update CI/CD badge links in documentation
cuicaihao May 3, 2025
b645563
chore: update Python version matrix to include 3.13
cuicaihao May 3, 2025
fca62d7
fix: update environment settings to use dynamic production/staging ba…
cuicaihao May 3, 2025
8fa9bef
chore: update version to 0.3.7 and remove outdated update log from RE…
cuicaihao May 4, 2025
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
22 changes: 11 additions & 11 deletions .github/workflows/python-CD.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,29 @@
branches: [master]
jobs:
format_and_check:
runs-on: ubuntu-20.04
environment: production
runs-on: ubuntu-22.04
environment: ${{ github.ref == 'refs/heads/master' && 'production' || 'staging' }}
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install black flake8
- name: Format with Black
run: |
black --check .

build:

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
needs: format_and_check
runs-on: ubuntu-20.04
environment: production
runs-on: ubuntu-22.04
environment: ${{ github.ref == 'refs/heads/master' && 'production' || 'staging' }}
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]

steps:
- uses: actions/checkout@v3
Expand Down Expand Up @@ -62,8 +62,8 @@

deploy:
needs: build
runs-on: ubuntu-20.04
environment: production
runs-on: ubuntu-22.04
environment: ${{ github.ref == 'refs/heads/master' && 'production' || 'staging' }}
steps:
- uses: actions/checkout@v3
- name: Set up Python
Expand Down Expand Up @@ -97,8 +97,8 @@

release:
needs: deploy
runs-on: ubuntu-20.04
environment: production
runs-on: ubuntu-22.04
environment: ${{ github.ref == 'refs/heads/master' && 'production' || 'staging' }}
steps:
- uses: actions/checkout@v3
- name: Set up Python
Expand Down Expand Up @@ -128,8 +128,8 @@

deploy_docs:
needs: build
runs-on: ubuntu-20.04
environment: production
runs-on: ubuntu-22.04
environment: ${{ github.ref == 'refs/heads/master' && 'production' || 'staging' }}
steps:
- uses: actions/checkout@v3
- name: Set up Python
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/python-CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,29 @@
branches: [develop, feature/*]
jobs:
format_and_check:
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
environment: development
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install black flake8
- name: Format with Black
run: |
black --check .

build:

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
needs: format_and_check
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
environment: development
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
Expand Down
1 change: 0 additions & 1 deletion .python-version
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

The MIT License (MIT)
Copyright (c) 2024, Caihao Cui
Copyright (c) 2025, Caihao Cui

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:

Expand Down
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![image](https://img.shields.io/pypi/pyversions/splitraster)](https://python.org/pypi/splitraster)
[![image](https://img.shields.io/pypi/v/splitraster?color=g)](https://python.org/pypi/splitraster)
[![CD](https://img.shields.io/github/actions/workflow/status/cuicaihao/split_raster/python-CD.yml?branch=master)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml)
[![SplitRaster Developmnet Build Install and Test](https://github.com/cuicaihao/split_raster/actions/workflows/python-CI.yml/badge.svg?branch=develop)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CI.yml)
[![SplitRaster Package Release and Publish](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml/badge.svg)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml)
[![DMonth](https://pepy.tech/badge/splitraster/month)](https://pepy.tech/project/splitraster)
[![DTotal](https://pepy.tech/badge/splitraster?)](https://pepy.tech/project/splitraster)
[![image](https://img.shields.io/github/license/cuicaihao/split_raster?color=blue)](https://python.org/pypi/splitraster)
Expand Down Expand Up @@ -172,13 +173,7 @@ n = geo.random_crop_image(input_tif_image_path, input_save_image_path, gt_tif_i
print(f"{n} sample paris of {input_tif_image_path, gt_tif_image_path} are added at {input_save_image_path, gt_save_image_path}.")

```

## Update Log
- 2024-Mar-23 Update github actions enable full CI/CD workflow, also add python 3.12 for build and test (https://pypi.org/project/splitraster/0.3.5/)
- 2023-Mar-19 Update github actions and add tutorial for the package.
- 2022-Dec-16 Upgrade the package to support python 3.8, 3.9, 3.10, 3.11 (https://pypi.org/project/splitraster/0.3.3).
- 2022-Jan-16 Fix bugs to make package suitable for python 3.7. Publish new version at(https://pypi.org/project/splitraster/0.3.2/) .


## Contribution Guidelines

If you run into issues or have questions, please [open an issue](https://github.com/cuicaihao/split_raster/issues) or [submit a pull request](https://github.com/cuicaihao/split_raster/pulls).
Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![image](https://img.shields.io/pypi/pyversions/splitraster)](https://python.org/pypi/splitraster)
[![image](https://img.shields.io/pypi/v/splitraster?color=g)](https://python.org/pypi/splitraster)
[![CD](https://img.shields.io/github/actions/workflow/status/cuicaihao/split_raster/python-CD.yml?branch=master)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml)
[![SplitRaster Developmnet Build Install and Test](https://github.com/cuicaihao/split_raster/actions/workflows/python-CI.yml/badge.svg?branch=develop)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CI.yml)
[![SplitRaster Package Release and Publish](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml/badge.svg)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml)
[![DMonth](https://pepy.tech/badge/splitraster/month)](https://pepy.tech/project/splitraster)
[![DTotal](https://pepy.tech/badge/splitraster?)](https://pepy.tech/project/splitraster)
[![image](https://img.shields.io/github/license/cuicaihao/split_raster?color=blue)](https://python.org/pypi/splitraster)
Expand Down
Empty file removed models/.gitkeep
View file
Open in desktop
Empty file.
Empty file removed references/.gitkeep
View file
Open in desktop
Empty file.
Empty file removed reports/.gitkeep
View file
Open in desktop
Empty file.
Empty file removed reports/figures/.gitkeep
View file
Open in desktop
Empty file.
12 changes: 4 additions & 8 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def read_requirements():

setup(
name="splitraster",
version="0.3.6",
version="0.3.7",
author="Chris Cui",
license="MIT",
platforms="any",
Expand All @@ -21,24 +21,20 @@ def read_requirements():
url="https://github.com/cuicaihao/split_raster",
package_dir={"": "src"},
project_urls={},
packages=find_packages(
where="src", exclude=["data", "features", "models", "visualization"]
),
python_requires=">=3.7, <3.13",
packages=find_packages(where="src", exclude=["data"]),
python_requires=">=3.7, <3.14",
keywords="split raster tiling ",
install_requires=read_requirements(),
classifiers=[
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"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",
"Programming Language :: Python :: 3.13",
],
)
# rm -rf build dist
Expand Down
151 changes: 0 additions & 151 deletions src/environment.yml
View file
Open in desktop

This file was deleted.

Empty file removed src/features/.gitkeep
View file
Open in desktop
Empty file.
Empty file removed src/features/__init__.py
View file
Open in desktop
Empty file.
Empty file removed src/features/build_features.py
View file
Open in desktop
Empty file.
65 changes: 0 additions & 65 deletions src/gui.py
View file
Open in desktop

This file was deleted.

Loading
Loading