diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100755 index 0000000..cd024d6 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to FINOS qPython Project +Thanks for taking the time to contribute! + +# Contributor License Agreement (CLA) +A CLA is a document that specifies how a project is allowed to use your +contribution; they are commonly used in many open source projects. + +**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/) +must be made with a +[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-ContributorLicenseAgreement) +in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-LicenseInformation) +that must also be met.** + +Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. + +As a result, PRs submitted to the kdb+ Project cannot be accepted until you have a CLA in place with the Foundation. + +Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org?subject=CLA) + + +# Contributing Issues + +## Prerequisites + +* [ ] Have you [searched for duplicates](https://github.com/finos-data-tech/kdb/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice. +* [ ] Are you running the latest version? +* [ ] Are you sure this is a bug or missing capability? + +## Raising an Issue +* Create your issue [here](https://github.com/finos-data-tech/kdb/issues/new). +* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**. + * Please also tag the new issue with either "Bug" or "Enhancement". +* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/) +liberally to assist in readability. + * [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability. + +# Contributing Pull Requests (Code & Docs) +To make review of PRs easier, please: + + * Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. + * For code contributions, follow the existing code layout. + * For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos-data-tech/kdb/wiki). + * Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too). + * Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it). + * Minimise non-functional changes (e.g. whitespace shenanigans). + * Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply). + * If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos-data-tech/kdb/blob/master/NOTICE) with any new attribution or other notices + + +## Commit and PR Messages + +* **Reference issues, wiki pages, and pull requests liberally!** +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move button left..." not "Moves button left...") +* Limit the first line to 72 characters or less diff --git a/CHANGELOG.txt b/CHANGELOG.txt index fed2929..f73d24e 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,3 +1,9 @@ +------------------------------------------------------------------------------ + qPython3 1.0.0 [2021.06.18] +------------------------------------------------------------------------------ + + - Add support for kdb 3.5+ protocol (messages up to 2TB, 64-bit list sizes) + ------------------------------------------------------------------------------ qPython 2.0.0 [2019.01.01] ------------------------------------------------------------------------------ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cadc7bb..459bd43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,12 @@ -To get started, sign the Contributor License Agreement. +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct) +4. Commit your changes (`git commit -am 'Add some fooBar'`) +5. Push to the branch (`git push origin feature/fooBar`) +6. Create a new Pull Request + +_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. + +*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)* diff --git a/README.rst b/README.rst index 6cd51dd..9176823 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,3 @@ -.. ATTENTION:: -This project is in maintenance mode. We may fix bugs, but no new features will be added in foreseeable future. - qPython ======= @@ -8,10 +5,10 @@ qPython is a Python library providing support for interprocess communication bet - Synchronous and asynchronous queries - Convenient asynchronous callbacks mechanism -- Support for kdb+ protocol and types: v3.0, v2.6, v<=2.5 +- Support for kdb+ protocol and types as of kdb+ v4.0 - Uncompression of the IPC data stream - Internal representation of data via numpy arrays (lists, complex types) and numpy data types (atoms) -- Supported on Python 2.7/3.4/3.5/3.6 and numpy 1.8+ +- Supported on Python 3.4/3.5/3.6 and numpy 1.8+ For more details please refer to the `documentation`_. @@ -21,9 +18,9 @@ Installation To install qPython from PyPI: -``$ pip install qpython`` +``$ pip install qpython3`` -**Please do not use old PyPI package name: exxeleron-qpython.** +**Please do not use old PyPI package name: qpython or exxeleron-qpython.** Building package