Skip to content

Commit 8844b1c

Browse files
Typo
1 parent f195248 commit 8844b1c

File tree

4 files changed

+10
-15
lines changed

4 files changed

+10
-15
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
# Prepare your build environment
3-
- Create a folder called fesapiEnv.
3+
- Create a folder called fetpapiEnv.
44
- In this folder create the three following folders
55
- build
6-
- fetpapi (Git clone this repository into this folder "fetpapi". You should then have a path fesapiEnv/fetpapi/src)
6+
- fetpapi (Git clone this repository into this folder "fetpapi". You should then have a path fetpapiEnv/fetpapi/src)
77
- dependencies
88
- The following compilers are known to work (used in CI)
99
- gcc from version 4.8
@@ -15,22 +15,19 @@ Download (build and install if necessary) third party libraries:
1515
- (OPTIONALLY) OpenSSL : version 1.1 is known to work.
1616
- (OPTIONALLY) [FESAPI](https://github.com/F2I-Consulting/fesapi/releases) : All versions from version 2.7.0.0 should be ok.
1717

18-
We advise you to install these third party libraries respectively into
19-
- fesapiEnv/dependencies/boost-particularVersion
20-
- fesapiEnv/dependencies/avro-particularVersion
2118
# Configure the build
2219
FETPAPI 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 :
2320

24-
- yourPath/fesapiEnv/fetpapi defines where is the source code folder
25-
- yourPath/fesapiEnv/build/theNameYouWant defines where to build the binaries
21+
- yourPath/fetpapiEnv/fetpapi defines where is the source code folder
22+
- yourPath/fetpapiEnv/build/theNameYouWant defines where to build the binaries
2623
- Click on "Configure" button and select your favorite compiler : it will raise several errors.
2724
- give real path and files to the following cmake variables:
2825
- BOOST
2926
- Boost_INCLUDE_DIR : the directory where you can find the directory named "boost" which contain all BOOST headers
3027
- AVRO (using [our own cmake find module](./cmake/modules/FindAVRO.cmake))
3128
- (ONLY IF NOT AUTOMATICALLY FOUND) AVRO_ROOT : The path to the folder containing include and lib folders of AVRO
3229
- Click again on "Configure" button. You should no more have errors so you can now click on "Generate" button.
33-
- You can now build your solution with your favorite compiler (and linker) using the generated solution in yourPath/fesapiEnv/build/theNameYouWant
30+
- You can now build your solution with your favorite compiler (and linker) using the generated solution in yourPath/fetpapiEnv/build/theNameYouWant
3431
- OPTIONALLY, you can also set the variables WITH_DOTNET_WRAPPING, WITH_PYTHON_WRAPPING to true if you want to also generate wrappers on top of FETPAPI for these two other programming languages. Don't forget to click again on "Configure" button once you changed the value of these two variables.
3532
- You will then have to also provide the path to the SWIG (version 3 as a mininum version) executable http://swig.org/download.html in the SWIG_EXECUTABLE variable (and click again on "Configure" button)
3633
- you will find the wrappers in fetpapi/cs/src (fetpapi/cs also contains a VS2015 project for the wrappers) or fetpapi/python/src

cmake/setup_etp.py.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ setup (name = 'fetpapi',
1515
url = 'https://github.com/F2I-Consulting/fetpapi',
1616
description = 'An API for the Energistics Transfer Protocol',
1717
long_description = '''**FETPAPI** is an API for Energistics Transfer Protocol (aka ETP™)
18-
ETP is the default standard to access the OSDU RDDMS.
18+
ETP is the default standard to interact with the OSDU RDDMS.
1919

2020
### Examples
2121

2222
A Python script and a Jupyter Notebook are available [here](https://github.com/F2I-Consulting/fetpapi/tree/dev/python/example).
2323

2424
### Credits
25-
FESAPI Product incorporates ETP™ technology/standards provided by the Energistics Consortium, Inc.
25+
FETPAPI Product incorporates ETP™ technology/standards provided by the Energistics Consortium, Inc.
2626

2727
ETP is trademark or registered trademark of Energistics Consortium, Inc.''',
2828
long_description_content_type = 'text/markdown',

doc/mainpage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FETPAPI is a library helping developers who want to develope an ETP™ client or server into a software.
1+
FETPAPI is a library helping developers who want to develop an ETP™ client or server into a software.
22

33
Key functionalities are:
44
- Open source (license Apache 2.0)
@@ -12,4 +12,4 @@ Key functionalities are:
1212
In this documentation, you would find all FETPAPI classes and their documentation into the **Classes** tab button above.
1313
Please feel very free to participate to this documentation by providing pull request on Github or comments on the [FETPAPI forum](https://discourse.f2i-consulting.com/c/etp/7).
1414

15-
<font size="1"> ETP is a trademark or registered trademark of Energistics Consortium, Inc.</font>
15+
<em>ETP is a trademark or registered trademark of Energistics Consortium, Inc.</em>

python/example/fetpapi.ipynb

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4267,14 +4267,12 @@
42674267
],
42684268
"source": [
42694269
"dataspace = all_dataspaces.front()\n",
4270-
"print(\"Working on dataspace \" + dataspace.uri);\n",
4271-
"# List resources of this ETP dataspace\n",
42724270
"etp_context = fetpapi.ContextInfo()\n",
42734271
"etp_context.uri = dataspace.uri\n",
42744272
"etp_context.depth = 1\n",
42754273
"all_resources = client_session.getResources(etp_context, fetpapi.ContextScopeKind__self);\n",
42764274
"if all_resources.empty() :\n",
4277-
" print(\"There is no resource on this dataspace.\")\n",
4275+
" print(\"There is no resource in dataspace \" + dataspace.uri)\n",
42784276
"for resource in all_resources:\n",
42794277
" print(resource.uri)"
42804278
]

0 commit comments

Comments
 (0)