XDress
XDress is an automatic wrapper generator for C/C++ written in pure Python. Currently, xdress may generate Python bindings (via Cython) for C++ classes & functions and in-memory wrappers for C++ standard library containers (sets, vectors, maps). In the future, other tools and bindings will be supported.
The main enabling feature of xdress is a dynamic type system that was designed with the purpose of API generation in mind.
Go here for the latest version of the docs!
Contents
tutorial advtut libclang libref/index rcdocs previous/index other/index faq authors
Installation
Since xdress is pure Python code, the pip or easy_install may be used to grab and install the code:
$ pip install xdress $ easy_install xdress
The source code repository for xdress may be found at the GitHub project site. You may simply clone the development branch using git:
git clone git://github.com/xdress/xdress.git
Also, if you wish to have the optional BASH completion, please add the following lines to your ~/.bashrc file:
# Enable completion for xdress eval "$(register-python-argcomplete xdress)"
Dependencies
XDress currently has the following external dependencies,
Run Time:
Clang/LLVM, optional for C/C++
pycparser, optional for C
GCC-XML, optional for C++
dOxygen, optional for docstrings
lxml, optional (but nice!)
argcomplete, optional for BASH completion
Compile Time:
Test Time:
Examples of Use
To see examples of xdress in action (and sample run control files), here are a few places to look:
xdress/tests/cproj: This is a fully functioning sample C project which uses xdress locally.
xdress/tests/cppproj: This is a fully functioning sample C++ project which uses xdress locally.
PyNE: This uses xdress to generate STL container wrappers.
Bright: This uses xdress to automatically wrap a suite of interacting C++ class. This was the motivating use case for the xdress project.
Testing
XDress has two major test types: unit tests which test library functionality and integration tests which test the command line tool, the parsers, compilers, etc. The unit tests are generally fast while the integration are slower. From the tests/ directory you may use nose to run the tests together or individually:
# Go into the tests dir $ cd tests # Run just the unit tests tests $ nosetests -a unit # Run just the integration tests tests $ nosetests -a integration # Run all of the tests together tests $ nosetests
Note that the integration tests require CMake in order to build the sample projects.
Contact Us
If you have questions or comments, please sign up for the the mailing list at https://groups.google.com/forum/#!forum/xdress and send an email to xdress@googlegroups.com. Alternatively, please contact the authors directly or open an issue on GitHub.
Contributing
We highly encourage contributions to xdress! If you would like to contribute, it is as easy as forking the repository on GitHub, making your changes, and issuing a pull request. If you have any questions about this process don’t hesitate to ask the mailing list (xdress@googlegroups.com).
Helpful Links
Metadata
Release files for xdress 0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xdress-0.4.tar.gz | 163.2 kB | Without provenance | Details for xdress-0.4.tar.gz |
Release files / xdress-0.4.tar.gz
| Download URL | xdress-0.4.tar.gz |
|---|---|
| Size | 163.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ad6efc1389e002a51e453d592bbb3ad4e3f8b0f3c3e51b7b4c9d54c3ba5a4d50
|
|
BLAKE2b-256 checksum How to use checksums |
e37ac28916dc4b2dd2a242d0a0ad9a3f9c7aa2caa1edfba22be917cc234f991f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for xdress 0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.