Skip to content

Commit c447036

Browse files
Improve documentation for Python version
1 parent bfb69f8 commit c447036

3 files changed

Lines changed: 18 additions & 7 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# If you just want some precompiled binaries (just to test for example)
2-
- Please first look in the [assets](https://github.com/F2I-Consulting/fesapi/releases) of the releases if it as already provided
2+
- Please first check in the [assets](https://github.com/F2I-Consulting/fesapi/releases) of the releases if your version has already been provided? For a Python version, just look at [PyPI](https://pypi.org/project/fesapi/).
33
- If not, create an [issue](https://github.com/F2I-Consulting/fesapi/issues/new?assignees=&labels=&projects=&template=feature_request.md) and ask for the version you would want.
44
# Prepare your build environment
55
- Create a folder called fesapiEnv.
@@ -23,7 +23,7 @@ We advise you to install these third party libraries respectively into
2323
- fesapiEnv/dependencies/minizip-particularVersion
2424
- fesapiEnv/dependencies/boost-particularVersion
2525
# Configure the build
26-
Fesapi uses cmake as its build tool. A 3.12 version or later of cmake is required https://cmake.org/download/. We also recommend using cmake-gui (already included in the bin folder of the binary releases of cmake) which provides a graphical user interface on top of cmake. If you want to use cmake in command line, you would find example in [GitHub Actions file](./.github/workflows/github-actions.yml). Follow the below instructions :
26+
FESAPI uses cmake as its build tool. A 3.12 version or later of cmake is required https://cmake.org/download/. We also recommend using cmake-gui (already included in the bin folder of the binary releases of cmake) which provides a graphical user interface on top of cmake. If you want to use cmake in command line, you would find example in [GitHub Actions file](./.github/workflows/github-actions.yml). Follow the below instructions :
2727

2828
- yourPath/fesapiEnv/fesapi defines where is the source code folder
2929
- yourPath/fesapiEnv/build/theNameYouWant defines where to build the binaries

cmake/setup.py.in

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,28 @@ setup (name = 'fesapi',
1313
maintainer = 'F2I-CONSULTING',
1414
url = 'https://github.com/F2I-Consulting/fesapi',
1515
description = 'An API for the Energistics standards',
16+
long_description = '''**FESAPI** is an API for Energistics data standards (mainly RESQML™)
17+
18+
### Examples
19+
20+
A Python script and a Jupyter Notebook are available [here](https://github.com/F2I-Consulting/fesapi/tree/dev/python/example).
21+
22+
### Credits
23+
This software was developed with :
24+
- the gSOAP toolkit from Genivia Inc
25+
- the date library from Howard Hinnant
26+
27+
FESAPI Product incorporates RESQML™, WITSML™ and PRODML™ technology/standards provided by the Energistics Consortium, Inc.
28+
29+
RESQML, WITSML and PRODML are trademarks or registered trademarks of Energistics Consortium, Inc.''',
30+
long_description_content_type = 'text/markdown',
1631
license = 'Apache 2.0',
1732
classifiers=[
1833
'Development Status :: 5 - Production/Stable',
1934
'Intended Audience :: Developers',
2035
'License :: OSI Approved :: Apache Software License',
2136
'Operating System :: Microsoft :: Windows',
22-
'Operating System :: POSIX',
37+
'Operating System :: POSIX :: Linux',
2338
'Natural Language :: English',
2439
'Programming Language :: Python :: 3',
2540
'Programming Language :: Python :: 3.6',

python/example/example.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
"""
2-
Please first install the wheel built in fesapi/python/dist
3-
"""
4-
51
from datetime import datetime
62
import fesapi
73

0 commit comments

Comments
 (0)