Readme
.. include-documentation-begin-marker
.. image:: https://github.com/zillow/ctds/workflows/CI/CD/badge.svg?branch=master :target: https://github.com/zillow/ctds/actions
.. image:: https://ci.appveyor.com/api/projects/status/voa33r7qdnxh6wwp/branch/master?svg=true :target: https://ci.appveyor.com/project/joshuahlang/ctds/branch/master
.. image:: http://img.shields.io/pypi/v/ctds.svg :target: https://pypi.python.org/pypi/ctds/
.. image:: https://codecov.io/gh/zillow/ctds/branch/master/graph/badge.svg :target: https://codecov.io/gh/zillow/ctds
cTDS is a full Python DB API-2.0_-compliant
SQL Server database library for Linux, Windows, and Mac OS X supporting
both Python 2 and Python 3.
The full documentation for cTDS can be found
here <https://zillow.github.io/ctds/>_.
Microsoft SQL Server <http://www.microsoft.com/sqlserver/>_ 2008 and up.DB API-2.0_ support.FreeTDS_Python_.. _FreeTDS: https://www.freetds.org/
.. _Python: https://www.python.org/
.. _DB API-2.0: https://www.python.org/dev/peps/pep-0249
.. include-documentation-end-marker
See installation instructions <https://zillow.github.io/ctds/install.html>_
for more information on installing FreeTDS_.
Publishing new versions of the egg and documentation is automated using a
Github Actions <https://docs.github.com/en/actions/>_ workflow.
Official releases are marked using git
tags <https://git-scm.com/book/en/v2/Git-Basics-Tagging>_. Pushing the
tag to the git remote will trigger the automated deployment. E.g.
.. code-block:: console
git tag -a v1.2.3 -m 'v1.2.3'
git push --tags
Generate documentation using the following:
.. code-block:: console
tox -e docs
# Generated to build/docs/
Documentation is hosted on GitHub Pages <https://pages.github.com/>.
As such, the source code for the documentation pages must be committed
to the gh-pages <https://github.com/zillow/ctds/tree/gh-pages> branch in
order to update the live documentation.
Local development and testing is supported on Linux-based systems running
tox_ and Docker. Docker containers are used for running a local instance
of SQL Server on Linux. Only Docker_ and tox_ are required for running
tests locally on Linux or OS X systems. pyenv_ is recommended for managing
multiple local versions of Python. By default all tests are run against
the system version of FreeTDS. GNU Make targets are provided to make
compiling specific FreeTDS_ versions locally for testing purposes. For
example:
.. code-block:: console
# Run tests against FreeTDS version 1.1.24
make test-1.1.24
Development and testing will require an instance of SQL Server on Linux_
running for validation. A script, ./scripts/ensure-sqlserver.sh, is provided
to start a Docker_ container running the database and create the login used
by the tests.
.. code-block:: console
# Start a docker-based SQL Server instance.
# The default tox targets will do this automatically for you.
make start-sqlserver
# Run tests as needed ...
# Stop the docker-base SQL Server instance.
make stop-sqlserver
Testing is designed to be relatively seamless using Docker_ containers
and SQL Server on Linux. The pytest framework is used for running
the automated tests.
To run the tests against the system version of FreeTDS_ and Python_,
use:
.. code-block:: console
tox
GNU make_ targets are provided for convenience and to provide a standard
method for building and installing the various versions of FreeTDS_ used
in testing. Most targets are wrappers around tox_ or replicate some
behavior in the CI/CD automation.
To run the tests against an arbitrary version of FreeTDS_:
.. code-block:: console
# Python X.Y & FreeTDS Z.ZZ.ZZ
make test_X.Y_Z.ZZ.ZZ
To run tests against all supported versions of FreeTDS_ and Python_
and additional linting and metadata checks:
.. code-block:: console
make check
valgrind_ is utilized to ensure memory is managed properly and to detect
defects such as memory leaks, buffer overruns, etc. Because valgrind_
requires Python is compiled with specific flags, a Docker_ file is provided
to compile Python_ as necessary to run the test suite under valgrind_.
To run test test suite under valgrind_:
.. code-block:: console
make valgrind
.. _Docker: https://www.docker.com/
.. _compile Python: https://pythonextensionpatterns.readthedocs.io/en/latest/debugging/valgrind.html
.. _SQL Server on Linux: https://hub.docker.com/r/microsoft/mssql-server-linux/
.. _GNU make: https://www.gnu.org/software/make/
.. _pyenv: https://github.com/pyenv/pyenv
.. _pytest: https://docs.pytest.org/en/stable/
.. _tox: https://tox.readthedocs.io/en/latest/
.. _valgrind: https://valgrind.org/
FAQs
DB API 2.0-compliant driver for SQL Server
We found that ctds demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.