Skip to content

Commit

Permalink
Update license year to 2025, bump version to 1.0.0, enhance README fo…
Browse files Browse the repository at this point in the history
…rmatting, and improve CI workflow with additional coverage reporting options
  • Loading branch information
nfornadimkhan committed Jan 1, 2025
1 parent b08343b commit 182d397
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
15 changes: 11 additions & 4 deletions .github/workflows/python-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ jobs:

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
Expand All @@ -37,12 +39,17 @@ jobs:
- name: Test with pytest
run: |
pytest --cov=dgNova --cov-report=xml
pytest --cov=dgNova --cov-report=xml --cov-report=term-missing
- name: Upload coverage reports to Codecov
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.xml
flags: unittests
name: codecov-umbrella
fail_ci_if_error: true
verbose: true

publish:
needs: build
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Nadim Khan
Copyright (c) 2025 Nadim Khan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[![Logo](documentation/logo.svg)](https://nfornadimkhan.github.io/dgNova/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python CI](https://github.com/nfornadimkhan/dgNova/actions/workflows/python-ci.yml/badge.svg)](https://github.com/nfornadimkhan/dgNova/actions/workflows/python-ci.yml)
[![codecov](https://codecov.io/gh/nfornadimkhan/dgNova/branch/main/graph/badge.svg)](https://codecov.io/gh/nfornadimkhan/dgNova)
[![PyPI version](https://badge.fury.io/py/dgNova.svg)](https://badge.fury.io/py/dgNova)

# dgNova (Designs Nova)

[![Logo](documentation/logo.svg)](https://nfornadimkhan.github.io/dgNova/)
A Python library for Statistical Analysis and Simulations of Plant Breeding Experiments, designed specifically for researchers and students who are new to programming but want to understand field design concepts through practical implementation.

![sample](https://github.com/user-attachments/assets/03bc5ccc-201d-414e-88f9-ba4a7a3eedb9)
Expand Down Expand Up @@ -43,7 +42,6 @@ Future implementations will include:
- Mating Design
- Fieldbook Generation
- Spatial Analysis
-

## Installation

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "dgNova"
version = "0.1.0"
version = "1.0.0"
description = "Statistical Analysis and Simulations for Plant Breeding Experiments"
readme = "README.md"
requires-python = ">=3.7"
Expand Down

0 comments on commit 182d397

Please sign in to comment.