Skip to content

Commit

Permalink
Merge pull request #371 from Lorak-mmk/various-improvements
Browse files Browse the repository at this point in the history
Updates for documentation and some cleanups
  • Loading branch information
Lorak-mmk authored Nov 6, 2024
2 parents 059e10e + ddda304 commit 18f5f01
Show file tree
Hide file tree
Showing 45 changed files with 88 additions and 6,974 deletions.
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Pre-review checklist

<!--
Make sure you took care of the issues on the list.
Put 'x' into those boxes which apply.
You can also create the PR now and click on all relevant checkboxes.
See CONTRIBUTING.rst for more details.
-->

- [ ] I have split my patch into logically separate commits.
- [ ] All commit messages clearly explain what they change and why.
- [ ] I added relevant tests for new features and bug fixes.
- [ ] All commits compile, pass static checks and pass test.
- [ ] PR description sums up the changes and reasons why they should be introduced.
- [ ] I have provided docstrings for the public items that I want to introduce.
- [ ] I have adjusted the documentation in `./docs/source/`.
- [ ] I added appropriate `Fixes:` annotations to PR description.
2 changes: 1 addition & 1 deletion .github/workflows/build-pre-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Build pre release python versions
on: [push, pull_request]

env:
CIBW_TEST_COMMAND_LINUX: "pytest --import-mode append {project}/tests/unit -k 'not (test_connection_initialization or test_cloud)'"
CIBW_TEST_COMMAND_LINUX: "pytest {project}/tests/unit"
CIBW_BEFORE_TEST: "pip install -r {project}/test-requirements.txt"
CIBW_BEFORE_BUILD_LINUX: "rm -rf ~/.pyxbld && rpm --import https://repo.almalinux.org/almalinux/RPM-GPG-KEY-AlmaLinux && yum install -y libffi-devel libev libev-devel openssl openssl-devel"
CIBW_ENVIRONMENT: "CASS_DRIVER_BUILD_CONCURRENCY=2 CFLAGS='-g0 -O3'"
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ on: [push, pull_request]


env:
CIBW_TEST_COMMAND_LINUX: "pytest --import-mode append {project}/tests/unit -k 'not (test_connection_initialization or test_cloud)' && EVENT_LOOP_MANAGER=gevent pytest --import-mode append {project}/tests/unit/io/test_geventreactor.py"
CIBW_TEST_COMMAND_MACOS: "pytest --import-mode append {project}/tests/unit -k 'not (test_multi_timer_validation or test_empty_connections or test_connection_initialization or test_timer_cancellation or test_cloud)' "
CIBW_TEST_COMMAND_WINDOWS: "pytest --import-mode append {project}/tests/unit -k \"not (test_deserialize_date_range_year or test_datetype or test_libevreactor or test_connection_initialization or test_cloud)\" "
CIBW_TEST_COMMAND_LINUX: "pytest {project}/tests/unit && EVENT_LOOP_MANAGER=gevent pytest {project}/tests/unit/io/test_geventreactor.py"
CIBW_TEST_COMMAND_MACOS: "pytest {project}/tests/unit -k 'not (test_multi_timer_validation or test_empty_connections or test_timer_cancellation)' "
CIBW_TEST_COMMAND_WINDOWS: "pytest {project}/tests/unit -k \"not (test_deserialize_date_range_year or test_datetype or test_libevreactor)\" "
CIBW_BEFORE_TEST: "pip install -r {project}/test-requirements.txt"
CIBW_BEFORE_BUILD_LINUX: "rm -rf ~/.pyxbld && rpm --import https://repo.almalinux.org/almalinux/RPM-GPG-KEY-AlmaLinux && yum install -y libffi-devel libev libev-devel openssl openssl-devel"
CIBW_ENVIRONMENT: "CASS_DRIVER_BUILD_CONCURRENCY=2 CFLAGS='-g0 -O3'"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ jobs:
run: |
export EVENT_LOOP_MANAGER=${{ matrix.event_loop_manager }}
export SCYLLA_VERSION='release:5.1'
./ci/run_integration_test.sh tests/integration/standard/ tests/integration/cqlengine/
./scripts/run_integration_test.sh tests/integration/standard/ tests/integration/cqlengine/
- name: Test tablets
run: |
export EVENT_LOOP_MANAGER=${{ matrix.event_loop_manager }}
export SCYLLA_VERSION='release:6.0.2'
./ci/run_integration_test.sh tests/integration/experiments/
./scripts/run_integration_test.sh tests/integration/experiments/
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,24 @@ tests/unit/cython/bytesio_testhelper.c
#iPython
*.ipynb

# Files from upstream that we don't need
Jenkinsfile
Jenkinsfile.bak
appveyor.yml
appveyor/appveyor.ps1
appveyor/run_test.ps1
build.yaml.bak
docs.yaml
doxyfile
tox.ini
test-datastax-requirements.txt
docs/api/cassandra/datastax/graph/fluent/index.rst
docs/api/cassandra/datastax/graph/fluent/predicates.rst
docs/api/cassandra/datastax/graph/fluent/query.rst
docs/api/cassandra/datastax/graph/index.rst
docs/api/cassandra/graph.rst
docs/classic_graph.rst
docs/core_graph.rst
docs/geo_types.rst
docs/graph.rst
docs/graph_fluent.rst
8 changes: 2 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Contributions are welcome in the form of bug reports or pull requests.

Bug Reports
-----------
Quality bug reports are welcome at the `DataStax Python Driver JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_.
Quality bug reports are welcome at the `Scylla Python Driver Github <https://github.com/scylladb/python-driver/issues>`_.

There are plenty of `good resources <http://www.drmaciver.com/2013/09/how-to-submit-a-decent-bug-report/>`_ describing how to create
good bug reports. They will not be repeated in detail here, but in general, the bug report include where appropriate:
Expand All @@ -18,11 +18,7 @@ good bug reports. They will not be repeated in detail here, but in general, the
Pull Requests
-------------
If you're able to fix a bug yourself, you can `fork the repository <https://help.github.com/articles/fork-a-repo/>`_ and submit a `Pull Request <https://help.github.com/articles/using-pull-requests/>`_ with the fix.
Please include tests demonstrating the issue and fix. For examples of how to run the tests, consult the `dev README <https://github.com/datastax/python-driver/blob/master/README-dev.rst#running-the-tests>`_.

Contribution License Agreement
------------------------------
To protect the community, all contributors are required to `sign the DataStax Contribution License Agreement <http://cla.datastax.com/>`_. The process is completely electronic and should only take a few minutes.
Please include tests demonstrating the issue and fix. For examples of how to run the tests, consult the `dev README <https://github.com/scylladb/python-driver/blob/master/README-dev.rst#running-the-tests>`_.

Design and Implementation Guidelines
------------------------------------
Expand Down
Loading

0 comments on commit 18f5f01

Please sign in to comment.