11Contributing
22------------------
3- Anyone can contribute, be it by coding, improving docs or just proposing a new feature.
3+ Anyone can contribute, be it by coding, improving docs or just proposing a new feature.
44As a new contributor, you may want to have a look at some of the following issues:
5- * [ ** good first issue** ] ( https://github.com/objectbox/objectbox-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) tag
5+ * [ ** good first issue** ] ( https://github.com/objectbox/objectbox-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) tag
66* [ ** help wanted** ] ( https://github.com/objectbox/objectbox-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 ) tag
77
8- When picking up an existing issue, please let others know in the issue comment.
8+ When picking up an existing issue, please let others know in the issue comment.
99Don't hesitate to reach out for guidance or to discuss a solution proposal!
1010
1111### Code contributions
@@ -16,20 +16,20 @@ When creating a Pull Request for code changes, please check that you cover the f
1616### Basic technical approach
1717ObjectBox offers a [ C API] ( https://github.com/objectbox/objectbox-c ) which can be integrated into python using
1818[ ctypes] ( https://docs.python.org/dev/library/ctypes.html ) .
19- The C API is is also used by the ObjectBox language bindings for [ Go] ( https://github.com/objectbox/objectbox-go ) ,
19+ The C API is is also used by the ObjectBox language bindings for [ Go] ( https://github.com/objectbox/objectbox-go ) ,
2020[ Swift] ( https://github.com/objectbox/objectbox-swift ) , and [ Dart/Flutter] ( https://github.com/objectbox/objectbox-dart ) .
2121These language bindings currently serve as an example for this Python implementation.
2222Internally, ObjectBox uses [ FlatBuffers] ( https://google.github.io/flatbuffers/ ) to store objects.
2323
24- The main prerequisite to using the Python APIs is the ObjectBox binary library (.so, .dylib, .dll depending on your
25- platform) which actually implements the database functionality. The library should be placed in the
26- ` objectbox/lib/[architecture]/ ` folder of the checked out repository. You can get/update it by running ` make get-lib ` .
24+ The main prerequisite to using the Python APIs is the ObjectBox binary library (.so, .dylib, .dll depending on your
25+ platform) which actually implements the database functionality. The library should be placed in the
26+ ` objectbox/lib/[architecture]/ ` folder of the checked out repository. You can get/update it by running ` make depend ` .
2727
2828### Getting started as a contributor
2929#### Initial setup
3030If you're just getting started, run the following simple steps to set up the repository on your machine
3131* clone this repository
32- * ` pip install virtualenv ` install [ virtualenv] ( https://pypi.org/project/virtualenv/ ) if you don't have it yet
32+ * ` python3 -m pip install --user virtualenv` install [ virtualenv] ( https://pypi.org/project/virtualenv/ ) if you don't have it yet
3333* ` make depend ` to initialize ` virtualenv ` and get dependencies (objectbox-c shared library)
3434* ` make ` to build and test
3535
0 commit comments