Skip to main content

CogneXa toolkit.

Project description

Bacx

toolbox

Content

About library

This is Python library with various tools designed primary for needs of Cognexa backend engineering team.

Install

$ pip install bacx

Examples

See documentation

Development

If you want to develop bacx, first:

  • clone this repo:
    $ git clone <repo path>
    
  • build docker image (to be able to test bacx):
    $ docker-compose build
    

You can then start python interpreter in bacx docker container and test there your changes to source files located in bacx and tests folder.

$ docker-compose run --rm bacx_storage python

There are some tasks in docs_dev folder (not included in build, so you may not see it).

Try bacx

To launch bacx in python interpreter inside docker:

  • start docker image:
    $ docker-compose run --rm bacx_storage python
    
  • import bacx:
    >>> import bacx
    

Run bacx tests:

Tests are located in tests/ folder. To run all tests inside docker:

$ docker-compose run --rm bacx_storage python -m unittest discover

or:

$ docker-compose run --rm test 

To run specific test (for example tests for config.py):

$ docker-compose run --rm bacx_storage python -m tests.utils.test_config  

Build pip package

If you need to build bacx from source, use this command from project root folder:

$ python setup.py bdist_wheel

It will build .whl bacx package and place it to dist folder. This package can be then installed for example using pip install:

$ pip install dist/<package name>.whl

To build package under project's pipenv use:

$ pipenv install --dev --ignore-pipfile --deploy
$ . "$(pipenv --venv)"/bin/activate
$ python setup.py bdist_wheel

Requires

See: Pipfile

Licence

MIT license

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

bacx-0.1.8-py3-none-any.whl (42.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page