prisma-api 0.3.1__tar.gz → 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. {prisma_api-0.3.1 → prisma_api-0.3.2}/PKG-INFO +8 -27
  2. {prisma_api-0.3.1 → prisma_api-0.3.2}/README.md +7 -26
  3. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api/__init__.py +1 -1
  4. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/PKG-INFO +8 -27
  5. {prisma_api-0.3.1 → prisma_api-0.3.2}/pyproject.toml +1 -1
  6. {prisma_api-0.3.1 → prisma_api-0.3.2}/LICENSE +0 -0
  7. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api/config.py +0 -0
  8. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api/prisma_api.py +0 -0
  9. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api/prisma_api_v2.py +0 -0
  10. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/SOURCES.txt +0 -0
  11. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/dependency_links.txt +0 -0
  12. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/requires.txt +0 -0
  13. {prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/top_level.txt +0 -0
  14. {prisma_api-0.3.1 → prisma_api-0.3.2}/setup.cfg +0 -0
  15. {prisma_api-0.3.1 → prisma_api-0.3.2}/tests/test_prisma_api.py +0 -0
  16. {prisma_api-0.3.1 → prisma_api-0.3.2}/tests/test_prisma_api_v2.py +0 -0
{prisma_api-0.3.1 → prisma_api-0.3.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: prisma_api
3
- Version: 0.3.1
3
+ Version: 0.3.2
4
4
  Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
5
5
  Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
6
6
  License: GNUv3
@@ -27,7 +27,6 @@ This package provides:
27
27
  - legacy v1 wrappers on the main `api` object
28
28
  - a larger v2 REST client on `api.v2`
29
29
  - local config-based API-key management
30
- - optional local development routing via `api.update_dev_mode(True)`
31
30
 
32
31
  PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
33
32
 
@@ -39,22 +38,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
39
38
  pip install prisma_api
40
39
  ```
41
40
 
42
- ### From source
43
-
44
- ```bash
45
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
46
- cd prisma_api
47
- pip install .
48
- ```
49
-
50
- ### Development install
51
-
52
- ```bash
53
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
54
- cd prisma_api
55
- pip install -e ".[dev]"
56
- ```
57
-
58
41
  ### Requirements
59
42
 
60
43
  - Python 3.10+
@@ -74,6 +57,12 @@ api = prisma_api.init()
74
57
 
75
58
  On first use, the package creates a config file and prompts for an API key.
76
59
 
60
+ ### Upgrades
61
+
62
+ ```python
63
+ pip install --upgrade prisma_api
64
+ ```
65
+
77
66
  ### Find the config path
78
67
 
79
68
  ```python
@@ -127,24 +116,16 @@ materials_df = api.v2.list_materials(name="ABEX")
127
116
  print(materials_df.head())
128
117
  ```
129
118
 
130
- ### Dev mode
119
+ ### Flowsheets
131
120
 
132
121
  ```python
133
122
  import prisma_api
134
123
 
135
- api = prisma_api.init()
136
- api.update_dev_mode(True)
137
124
  api = prisma_api.init()
138
125
 
139
126
  flowsheet = api.v2.get_flowsheet(name="dac_min")
140
127
  ```
141
128
 
142
- Disable dev mode the same way:
143
-
144
- ```python
145
- api.update_dev_mode(False)
146
- api = prisma_api.init()
147
- ```
148
129
 
149
130
  ## Return formats
150
131
 
{prisma_api-0.3.1 → prisma_api-0.3.2}/README.md RENAMED
@@ -7,7 +7,6 @@ This package provides:
7
7
  - legacy v1 wrappers on the main `api` object
8
8
  - a larger v2 REST client on `api.v2`
9
9
  - local config-based API-key management
10
- - optional local development routing via `api.update_dev_mode(True)`
11
10
 
12
11
  PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
13
12
 
@@ -19,22 +18,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
19
18
  pip install prisma_api
20
19
  ```
21
20
 
22
- ### From source
23
-
24
- ```bash
25
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
26
- cd prisma_api
27
- pip install .
28
- ```
29
-
30
- ### Development install
31
-
32
- ```bash
33
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
34
- cd prisma_api
35
- pip install -e ".[dev]"
36
- ```
37
-
38
21
  ### Requirements
39
22
 
40
23
  - Python 3.10+
@@ -54,6 +37,12 @@ api = prisma_api.init()
54
37
 
55
38
  On first use, the package creates a config file and prompts for an API key.
56
39
 
40
+ ### Upgrades
41
+
42
+ ```python
43
+ pip install --upgrade prisma_api
44
+ ```
45
+
57
46
  ### Find the config path
58
47
 
59
48
  ```python
@@ -107,24 +96,16 @@ materials_df = api.v2.list_materials(name="ABEX")
107
96
  print(materials_df.head())
108
97
  ```
109
98
 
110
- ### Dev mode
99
+ ### Flowsheets
111
100
 
112
101
  ```python
113
102
  import prisma_api
114
103
 
115
- api = prisma_api.init()
116
- api.update_dev_mode(True)
117
104
  api = prisma_api.init()
118
105
 
119
106
  flowsheet = api.v2.get_flowsheet(name="dac_min")
120
107
  ```
121
108
 
122
- Disable dev mode the same way:
123
-
124
- ```python
125
- api.update_dev_mode(False)
126
- api = prisma_api.init()
127
- ```
128
109
 
129
110
  ## Return formats
130
111
 
{prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api/__init__.py RENAMED
@@ -1,4 +1,4 @@
1
- __version__ = "0.3.1"
1
+ __version__ = "0.3.2"
2
2
 
3
3
 
4
4
  from prisma_api.prisma_api import prisma_api as init # Main prisma_api class for initialisation
{prisma_api-0.3.1 → prisma_api-0.3.2}/prisma_api.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: prisma_api
3
- Version: 0.3.1
3
+ Version: 0.3.2
4
4
  Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
5
5
  Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
6
6
  License: GNUv3
@@ -27,7 +27,6 @@ This package provides:
27
27
  - legacy v1 wrappers on the main `api` object
28
28
  - a larger v2 REST client on `api.v2`
29
29
  - local config-based API-key management
30
- - optional local development routing via `api.update_dev_mode(True)`
31
30
 
32
31
  PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
33
32
 
@@ -39,22 +38,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
39
38
  pip install prisma_api
40
39
  ```
41
40
 
42
- ### From source
43
-
44
- ```bash
45
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
46
- cd prisma_api
47
- pip install .
48
- ```
49
-
50
- ### Development install
51
-
52
- ```bash
53
- git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
54
- cd prisma_api
55
- pip install -e ".[dev]"
56
- ```
57
-
58
41
  ### Requirements
59
42
 
60
43
  - Python 3.10+
@@ -74,6 +57,12 @@ api = prisma_api.init()
74
57
 
75
58
  On first use, the package creates a config file and prompts for an API key.
76
59
 
60
+ ### Upgrades
61
+
62
+ ```python
63
+ pip install --upgrade prisma_api
64
+ ```
65
+
77
66
  ### Find the config path
78
67
 
79
68
  ```python
@@ -127,24 +116,16 @@ materials_df = api.v2.list_materials(name="ABEX")
127
116
  print(materials_df.head())
128
117
  ```
129
118
 
130
- ### Dev mode
119
+ ### Flowsheets
131
120
 
132
121
  ```python
133
122
  import prisma_api
134
123
 
135
- api = prisma_api.init()
136
- api.update_dev_mode(True)
137
124
  api = prisma_api.init()
138
125
 
139
126
  flowsheet = api.v2.get_flowsheet(name="dac_min")
140
127
  ```
141
128
 
142
- Disable dev mode the same way:
143
-
144
- ```python
145
- api.update_dev_mode(False)
146
- api = prisma_api.init()
147
- ```
148
129
 
149
130
  ## Return formats
150
131
 
{prisma_api-0.3.1 → prisma_api-0.3.2}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "prisma_api"
7
- version = "0.3.1"
7
+ version = "0.3.2"
8
8
  description = "A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk."
9
9
  authors = [
10
10
  {name = "RCCS-CaptureTeam", email = "team@prisma-platform.org"}
{prisma_api-0.3.1 → prisma_api-0.3.2}/LICENSE RENAMED
File without changes
{prisma_api-0.3.1 → prisma_api-0.3.2}/setup.cfg RENAMED
File without changes