Skip to content

docs(readme): update sections#76

Merged
carlobortolan merged 1 commit intomasterfrom
carlobortolan-patch-1
Aug 30, 2025
Merged

docs(readme): update sections#76
carlobortolan merged 1 commit intomasterfrom
carlobortolan-patch-1

Conversation

@carlobortolan
Copy link
Copy Markdown
Owner

Merged the Outlook section into the Contributing section.

Merged the Outlook section into the Contributing section.

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
@carlobortolan carlobortolan self-assigned this Aug 30, 2025
@carlobortolan carlobortolan added the documentation Improvements or additions to documentation label Aug 30, 2025
@carlobortolan carlobortolan merged commit f5ec864 into master Aug 30, 2025
3 of 4 checks passed
@codecov
Copy link
Copy Markdown

codecov bot commented Aug 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.14%. Comparing base (4b04118) to head (6f9ef70).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #76   +/-   ##
=======================================
  Coverage   91.14%   91.14%           
=======================================
  Files          25       25           
  Lines        2574     2574           
=======================================
  Hits         2346     2346           
  Misses        228      228           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

SaurabhJamadagni pushed a commit to SaurabhJamadagni/quantrs that referenced this pull request Sep 4, 2025
Merged the Outlook section into the Contributing section.

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
carlobortolan added a commit that referenced this pull request Sep 15, 2025
* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* feat(data): traits setup for data sources (#63)

* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* chore(deps): bump criterion from 0.6.0 to 0.7.0 (#67)

* chore(deps): bump criterion from 0.6.0 to 0.7.0

Bumps [criterion](https://github.com/bheisler/criterion.rs) from 0.6.0 to 0.7.0.
- [Changelog](https://github.com/bheisler/criterion.rs/blob/master/CHANGELOG.md)
- [Commits](bheisler/criterion.rs@0.6.0...0.7.0)

---
updated-dependencies:
- dependency-name: criterion
  dependency-version: 0.7.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update Cargo.lock and Cargo.lock.MSRV

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>

* chore(deps): bump rand from 0.9.1 to 0.9.2 (#66)

* chore(deps): bump rand from 0.9.1 to 0.9.2

Bumps [rand](https://github.com/rust-random/rand) from 0.9.1 to 0.9.2.
- [Release notes](https://github.com/rust-random/rand/releases)
- [Changelog](https://github.com/rust-random/rand/blob/master/CHANGELOG.md)
- [Commits](rust-random/rand@rand_core-0.9.1...rand_core-0.9.2)

---
updated-dependencies:
- dependency-name: rand
  dependency-version: 0.9.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update Cargo.lock.MSRV

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>

* feat(fixed_income): add basic FI structure (#74)

* Add FI module definition

* Add trait module for FI

* Add PriceResult struct

* Add FI types and custom pricing errors

* Update day_count to include year_fraction and day_count methods

* Add TODOs

* Remove out unused future bond imports

* Add basic tests

* Add cashflow tests for schedule generation and price result validation

* Remove unused imports and bond_price function stub from bond_pricing.rs

* Update README (#76)

Merged the Outlook section into the Contributing section.

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat(fixed_income): implement zero-coupon bond pricing (#75)

* Add FI module definition

* Add trait module for FI

* Add PriceResult struct

* Add FI types and custom pricing errors

* Add ZeroCouponBond struct and implement Bond trait for pricing

* Update day_count to include year_fraction and day_count methods

* Add TODOs

* Refactor ZeroCouponBond pricing logic to use DayCountConvention

* Refactor bond module documentation and add test cases for ZeroCouponBond

* Remove out unused future bond imports

* Add basic tests

* Add cashflow tests for schedule generation and price result validation

* Remove unused imports and bond_price function stub from bond_pricing.rs

* Update README and add Zero Coupon Bond example

* update zero coupon bond tests and add day count tests

* add maturity handling to FI day_counts

* fix linting

* add validation tests for ZeroCouponBond pricing errors

* update tests

* remove unused leap year check

* update icma daycount tests

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* fix: allowing for dead code to fix linting checks

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* fix: Draft PR suggestions v1

* feat: adding company overview fundamental data

* fix: merge conflict fixes

* feat(data): traits setup for data sources (#63)

* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* fix: merge conflict fixes

* Update MSRV and dependencies

- Bump minimum supported Rust version from 1.77.0 to 1.82.0 in Cargo.toml and README.md.
- Update reqwest dependency from version 0.12 to 0.12.23.
- Upgrade tokio dependency from version 1.46.1 to 1.47.1.

* update main function to use Tokio runtime and improve output formatting for stock quotes

* test: async call success check for get_stock_quote & get_company_overview

* test: removing redundant import

* update deps in Cargo.lock and Cargo.lock.MSRV

* update AlphaVantageSource initialization and add request fail test case

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Saurabh Jamadagni <68957712+SaurabhJamadagni@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>
SaurabhJamadagni added a commit to SaurabhJamadagni/quantrs that referenced this pull request Feb 4, 2026
* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (carlobortolan#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* feat(data): traits setup for data sources (carlobortolan#63)

* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (carlobortolan#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* chore(deps): bump criterion from 0.6.0 to 0.7.0 (carlobortolan#67)

* chore(deps): bump criterion from 0.6.0 to 0.7.0

Bumps [criterion](https://github.com/bheisler/criterion.rs) from 0.6.0 to 0.7.0.
- [Changelog](https://github.com/bheisler/criterion.rs/blob/master/CHANGELOG.md)
- [Commits](bheisler/criterion.rs@0.6.0...0.7.0)

---
updated-dependencies:
- dependency-name: criterion
  dependency-version: 0.7.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update Cargo.lock and Cargo.lock.MSRV

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>

* chore(deps): bump rand from 0.9.1 to 0.9.2 (carlobortolan#66)

* chore(deps): bump rand from 0.9.1 to 0.9.2

Bumps [rand](https://github.com/rust-random/rand) from 0.9.1 to 0.9.2.
- [Release notes](https://github.com/rust-random/rand/releases)
- [Changelog](https://github.com/rust-random/rand/blob/master/CHANGELOG.md)
- [Commits](rust-random/rand@rand_core-0.9.1...rand_core-0.9.2)

---
updated-dependencies:
- dependency-name: rand
  dependency-version: 0.9.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update Cargo.lock.MSRV

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>

* feat(fixed_income): add basic FI structure (carlobortolan#74)

* Add FI module definition

* Add trait module for FI

* Add PriceResult struct

* Add FI types and custom pricing errors

* Update day_count to include year_fraction and day_count methods

* Add TODOs

* Remove out unused future bond imports

* Add basic tests

* Add cashflow tests for schedule generation and price result validation

* Remove unused imports and bond_price function stub from bond_pricing.rs

* Update README (carlobortolan#76)

Merged the Outlook section into the Contributing section.

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat(fixed_income): implement zero-coupon bond pricing (carlobortolan#75)

* Add FI module definition

* Add trait module for FI

* Add PriceResult struct

* Add FI types and custom pricing errors

* Add ZeroCouponBond struct and implement Bond trait for pricing

* Update day_count to include year_fraction and day_count methods

* Add TODOs

* Refactor ZeroCouponBond pricing logic to use DayCountConvention

* Refactor bond module documentation and add test cases for ZeroCouponBond

* Remove out unused future bond imports

* Add basic tests

* Add cashflow tests for schedule generation and price result validation

* Remove unused imports and bond_price function stub from bond_pricing.rs

* Update README and add Zero Coupon Bond example

* update zero coupon bond tests and add day count tests

* add maturity handling to FI day_counts

* fix linting

* add validation tests for ZeroCouponBond pricing errors

* update tests

* remove unused leap year check

* update icma daycount tests

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* fix: allowing for dead code to fix linting checks

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* fix: Draft PR suggestions v1

* feat: adding company overview fundamental data

* fix: merge conflict fixes

* feat(data): traits setup for data sources (carlobortolan#63)

* chore: initial issue structure setup

* feat: trait structure for data sources

* fix(linting): string formatting (carlobortolan#64)

* refactor: string formatting

* refactor: update string formatting

* fix: changes to fix linting issues and scope changes

* fix: changed variable with camel case causing linting error

* fix: allowing for dead code to fix linting checks

* test: Adding initial stage tests for data module

* Update tests/data.rs

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: trait structure for data sources

* fix: changes to fix linting issues and scope changes

* feat: saving current state of code based on a parent trait

* feat: fetch global quote for alpha vantage

* fix: merge conflict fixes

* Update MSRV and dependencies

- Bump minimum supported Rust version from 1.77.0 to 1.82.0 in Cargo.toml and README.md.
- Update reqwest dependency from version 0.12 to 0.12.23.
- Upgrade tokio dependency from version 1.46.1 to 1.47.1.

* update main function to use Tokio runtime and improve output formatting for stock quotes

* test: async call success check for get_stock_quote & get_company_overview

* test: removing redundant import

* update deps in Cargo.lock and Cargo.lock.MSRV

* update AlphaVantageSource initialization and add request fail test case

---------

Signed-off-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Saurabh Jamadagni <68957712+SaurabhJamadagni@users.noreply.github.com>
Co-authored-by: Carlo Bortolan <106114526+carlobortolan@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: carlobortolan <carlobortolan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant