Browse Source

typos etc..

PYADPT-100
heck 5 years ago
parent
commit
6fefb8a0c9
  1. 2
      README.rst
  2. 32
      docs/source/install.rst

2
README.rst

@ -1,6 +1,6 @@
pEpPythonAdapter pEpPythonAdapter
================ ================
Python adapter for the [pEpEngine](https://pep.foundation/dev/repos/pEpEngine/) Python adapter for the `pEpEngine <https://pep.foundation/dev/repos/pEpEngine/>`_
Documentation Documentation

32
docs/source/install.rst

@ -14,7 +14,7 @@ These `build instructions <https://dev.pep.foundation/Common%20Adapter%20Documen
Additionally, there is a `build script <http://pep-security.lu/gitlab/juga/Internal-Deployment/-/blob/master/build-pep-stack.sh>`_ Additionally, there is a `build script <http://pep-security.lu/gitlab/juga/Internal-Deployment/-/blob/master/build-pep-stack.sh>`_
that executes these build instructions automatically (Debian and MacOS): that executes these build instructions automatically (Debian and MacOS):
.. Note:: If you dont install pEp-base system wide, but under a prefix, like /home/foo/local/ .. Note:: If you dont install pEp-base system wide, but under a prefix, like /home/foo/local/,
you will need to have LD_LIBARY_PATH/DYLD_LIBRARY_PATH adjusted for all the following operations. you will need to have LD_LIBARY_PATH/DYLD_LIBRARY_PATH adjusted for all the following operations.
@ -42,25 +42,13 @@ To build the module just type:
This will compile the C/C++ parts of the module and create the python packages in the .egg and .wheel format This will compile the C/C++ parts of the module and create the python packages in the .egg and .wheel format
in the dist/ dir. in the dist/ dir.
Installation
------------
You can install the module in the in the following ways:
To install the extension module system wide or into a venv:
``make install``
To install the extension module into you home dir:
``make install-user``
Virtualenv Virtualenv
---------- ----------
We recommend using a venv to work on/with the pEpPythonAdapter. We recommend using a venv to work on/with the pEpPythonAdapter.
There is a convenience make target that will create and activate a venv that already has the LD_LIBRARY_PATH There is a convenience make target that will create and activate a venv that already has the LD_LIBRARY_PATH
or DYLD_LIBRARY_PATH set according to your ```local.conf``. or DYLD_LIBRARY_PATH set according to your ``local.conf``.
If the venv is not existing yet it will be created and activated. If the venv does not yet it will be created and activated.
If the venv already exists it will only be activated. If the venv already exists it will only be activated.
``make venv`` ``make venv``
@ -69,6 +57,20 @@ After that, to install the pEp module into the venv, do:
``make install`` ``make install``
Installation
------------
You can install the module in the in the following ways.
To install the extension module system wide or into a venv, use:
``make install``
To install the extension module into your home dir, use:
``make install-user``
Test Test
---- ----
To run the whole testsuite you need to create/activate the venv, and then invoke the make target 'test'. To run the whole testsuite you need to create/activate the venv, and then invoke the make target 'test'.

Loading…
Cancel
Save