chore: package updates - Githubissues

facioquo / stock-indicators-python

Stock Indicators for Python. Maintained by @LeeDongGeon1996

https://python.StockIndicators.dev

Apache License 2.0

221 stars 37 forks source link

chore: package updates #229

Closed DaveSkender closed 2 years ago

DaveSkender commented 2 years ago

Description

Compatibility updates for skender.stock.indicators v1.23.1

Checklist

[x] My code follows the existing style, code structure, and naming taxonomy
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have performed a self-review of my own code and included any verifying manual calculations
[x] I have added or updated unit tests that prove my fix is effective or that my feature works, and achieves sufficient code coverage. New and existing unit tests pass locally and in the build (below) with my changes
[x] My changes generate no new warnings and running code analysis does not produce any issues
[x] I have added or run the performance tests that depict optimal execution times
[x] I have made corresponding changes to the documentation

DaveSkender commented 2 years ago

@LeeDongGeon1996 do we have any documentation on how to get started as a developer, from a prerequisite software installation perspective. I couldn't get set up quite right on my local machine to run tests, so I had to just push to the PR to see if it works.

DaveSkender commented 2 years ago

This might be a good 0.7.1 patch update to PyPI?

LeeDongGeon1996 commented 2 years ago

@LeeDongGeon1996 do we have any documentation on how to get started as a developer, from a prerequisite software installation perspective. I couldn't get set up quite right on my local machine to run tests, so I had to just push to the PR to see if it works.

For the test, I think we already have for that. https://daveskender.github.io/Stock.Indicators.Python/contributing/#testing Is there something missed in requirements-test.txt?

This might be a good 0.7.1 patch update to PyPI?

That would be great :)

LeeDongGeon1996 commented 2 years ago

@DaveSkender How do you think that updating minor version, not a patch version? Because there are some incompatible updates (file name changed, some helper methods removed)

DaveSkender commented 2 years ago

Sure. The key minor version threshold for me is usually 1) is it a new or expanded feature, or 2) is it a breaking change?

In the .NET project, for renaming things, I often keep the old name around too, so it's not actually breaking, but add the compiler warning and segregate the obsolete interface for easy removal at a larger versioning increment.