dve-lumipy-testing 1.0.389__py3-none-any.whl → 1.0.391__py3-none-any.whl

{dve_lumipy_testing-1.0.389.dist-info → dve_lumipy_testing-1.0.391.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dve-lumipy-testing
-Version: 1.0.389
+Version: 1.0.391
 Summary: Python library for Luminesce
 Author: FINBOURNE Technology
 Author-email: engineering@finbourne.com
@@ -91,37 +91,6 @@ lm.config.add('fbn-ci', '<your PAT>')
 lm.config.domain = 'fbn-ci'
 ```
 
-## Query
-All built around the atlas object. This is the starting point for exploring your data sources and then using them.
-
-Build your atlas with `lm.get_atlas`. If you don't supply credentials it will default to your active domain in the config. 
-If there is no active domain in your config it will fall back to env vars. 
-```python
-import lumipy as lm
-
-atlas = lm.get_atlas()
-
-ins = atlas.lusid_instrument()
-ins.select('^').limit(10).go()
-```
-You can also specify the domain here by a positional argument, e.g. `lm.get_atlas('fbn-ci')` will use `fbn-ci` and will override the active domain. 
-
-Client objects are created in the same way. You can submit raw SQL strings as queries using `run()`
-```python
-import lumipy as lm
-
-client = lm.get_client()
-client.run('select ^ from lusid.instrument limit 10')
-```
-
-You can create a `client` or `atlas` for a domain other than the active one by specifying it in `get_client` or `get_atlas`. 
-```python
-import lumipy as lm
-
-client = lm.get_client('fbn-prd')
-atlas = lm.get_atlas('fbn-prd')
-```
-
 ## Connect
 
 Python providers are build by inheriting from a base class, `BaseProvider`, and implementing the `__init__` and `get_data` methods.
@@ -273,7 +242,7 @@ Directory
 ```
 
 
-## Query
+## Query Using SQL
 This command runs a SQL query, gets the result back, shows it on screen and then saves it as a CSV.
 
 ### Query Examples
@@ -352,9 +321,11 @@ Authenticate by setting up the PAT token via the CLI or directly in Python (see
 
 ### Secrets File
 Initialize `get_client` using a secrets file:
+
 ```python
 client = get_client(api_secrets_file="secrets_file_path/secrets.json")
 ```
+
 File structure should be:
 ```json
 {
@@ -407,3 +378,211 @@ The following environment variables can also be set:
 - FBN_PROXY_USERNAME
 - FBN_PROXY_PASSWORD
 - FBN_ACCESS_TOKEN
+
+# Lumipy Atlas and LumiFlex
+
+This guide demonstrates how to use the Lumipy Atlas interface to query data providers, transform data, join datasets, create views, and interact with external services like AWS S3, Drive, and Slack.
+
+
+### Query 
+
+All built around the `atlas` object. This is the starting point for exploring your data sources and then using them.
+
+Build your atlas with `lm.get_atlas`. If you don't supply credentials it will default to your active domain in the config.  
+If there is no active domain in your config it will fall back to env vars. 
+
+```python
+import lumipy as lm
+
+atlas = lm.get_atlas()
+
+ins = atlas.lusid_instrument()
+ins.select('^').limit(10).go()
+```
+
+You can also specify the domain here by a positional argument, e.g. `lm.get_atlas('fbn-ci')` will use `fbn-ci` and will override the active domain. 
+
+Client objects are created in the same way. You can submit raw SQL strings as queries using `run()`
+
+```python
+import lumipy as lm
+
+client = lm.get_client()
+client.run('select ^ from lusid.instrument limit 10')
+```
+
+You can create a `client` or `atlas` for a domain other than the active one by specifying it in `get_client` or `get_atlas`. 
+
+```python
+import lumipy as lm
+
+client = lm.get_client('fbn-prd')
+atlas = lm.get_atlas('fbn-prd')
+```
+
+
+
+### Querying a Provider
+
+```python
+pf = atlas.lusid_portfolio(as_at=dt.datetime(2022, 9, 1))
+df = pf.select('*').limit(10).go()
+```
+
+
+
+### Select New Columns
+
+```python
+df = pf.select(
+    '^',  # all original main columns
+    LoudNoises=pf.portfolio_code.str.upper(),
+    IntVal=7,
+    BoolVal=False
+).limit(10).go()
+```
+
+
+
+### Where Filtering
+
+```python
+df = pf.select('*').where(pf.portfolio_scope == 'Finbourne-Examples').go()
+```
+
+
+
+### Order By
+
+```python
+df = pf.select('*').where(
+    pf.portfolio_scope == 'Finbourne-Examples'
+).order_by(
+    pf.portfolio_code.ascending()
+).go()
+```
+
+
+
+### Case Statements and Group By
+
+```python
+region = lm.when(pf.portfolio_code.str.contains('GLOBAL')).then('GLOBAL') \
+           .when(pf.portfolio_code.str.contains('US')).then('US') \
+           .otherwise('OTHER')
+
+df = pf.select(Region=region).where(
+    pf.portfolio_scope == 'Finbourne-Examples'
+).group_by(
+    Region=region
+).aggregate(
+    PortfolioCount=pf.portfolio_code.count()
+).go()
+```
+
+
+
+### Having
+
+```python
+df = pf.select(Region=region).where(
+    pf.portfolio_scope == 'Finbourne-Examples'
+).group_by(
+    Region=region
+).aggregate(
+    PortfolioCount=pf.portfolio_code.count()
+).having(
+    pf.portfolio_code.count() > 3
+).go()
+```
+
+
+
+### Joins
+
+```python
+tv = pf.select('^').where(pf.portfolio_scope == 'Finbourne-Examples').to_table_var()
+hld = atlas.lusid_portfolio_holding(as_at=dt.datetime(2022, 9, 1))
+
+df = tv.left_join(hld, on=tv.portfolio_code == hld.portfolio_code).select('*').go()
+```
+
+
+
+### Union / Concat
+
+```python
+df = lm.concat([query1, query2, query3]).go()
+```
+
+
+
+### Sampling
+
+```python
+# Sample by fraction
+df = pf.select('*').limit(200).sample(prob=0.5).go()
+
+# Sample by count
+df = pf.select('*').limit(200).sample(100).go()
+```
+
+
+
+### Create View
+
+```python
+df = pf.select('*').setup_view('Lumipy.View.MyView').go()
+```
+
+
+
+### S3, Drive, and SaveAs Integration
+
+```python
+# Load CSV from S3
+csv = atlas.awss3_csv(file='bucket/path/file.csv')
+df = csv.select('*').go()
+
+# Save table variable to Drive
+save = atlas.drive_saveas(tv, type='CSV', path='/my-path/', file_names='exported_file')
+df = save.select('*').go()
+```
+
+
+
+### Slack Integration
+
+```python
+# Send table var as CSV
+slack = atlas.dev_slack_send(
+    tv,
+    attach_as='CSV',
+    channel='#channel-name',
+    text='Here is your result!'
+)
+df = slack.select('*').go()
+```
+
+
+
+### Built-in Analytics
+
+```python
+df = ar.select(
+    ar.timestamp,
+    ar.duration,
+    Drawdown=lm.window().finance.drawdown(ar.duration)
+).go()
+```
+
+
+
+### Cumulative and Fractional Functions
+
+```python
+df = ar.select(
+    CumeSum=ar.duration.cume.sum(),
+    FracDiff=ar.duration.frac_diff()
+).go()
+```

{dve_lumipy_testing-1.0.389.dist-info → dve_lumipy_testing-1.0.391.dist-info}/RECORD

@@ -78,7 +78,7 @@ lumipy/provider/common.py,sha256=2NMoIDYEkO0km1TcRc_KWZ5NWpo02eBtByKB2_d-mpM,682
 lumipy/provider/context.py,sha256=VwsHZO46HP3G9BN4Eot_jQlbfETGKyNg2vG5wm1zL_4,5401
 lumipy/provider/factory.py,sha256=QFuSCT_byJwbFmHF669I2iz0vLAF0T9Or1ghIEUZ0ok,9257
 lumipy/provider/manager.py,sha256=A4bxCO__m5nc9GL8veOLtySbK1giMNDMml_r3B-q8y8,7218
-lumipy/provider/max_version.py,sha256=7mify-_MCrww_bOmuJtONL0KCg3x11CxDYxCNt0dKJM,28
+lumipy/provider/max_version.py,sha256=SM-ytRJBHWLYhBmiQDYvCyoVZLdmGNzDETnyG3S6gFo,28
 lumipy/provider/metadata.py,sha256=WGfMv_tLn5W29-zMKipqBpueroe0eF-w9Hj_6QRdZAI,5483
 lumipy/provider/provider_sets.py,sha256=Z_VyiN2dBP1xuIdRiuGgyzLD7LfO4wxFvodprME2Uls,1478
 lumipy/provider/implementation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -271,7 +271,7 @@ lumipy/test/data/context_examples/test_titanic_single_bool_column.json,sha256=SC
 lumipy/test/data/context_examples/test_titanic_test_ignore.json,sha256=HYEcQ3CGrtZ9sdacVnn8Vs38tJi4B7I2Tqqo1kS5BLY,575
 lumipy/test/integration/__init__.py,sha256=Qb9wYCQF3WMv7emOmpAvnYzvLi3C_dGOqyheycYzp_g,192
 lumipy/test/integration/test_atlas_build_queries.py,sha256=2wS-kW4uwrUleOU1bRYEHvxmxkWevskw4eIzp1dGUXQ,1286
-lumipy/test/integration/test_client.py,sha256=U2XVRPQBUr0U_aU5IVFTD5tIg3cdLUHRVXQj446WS8U,9950
+lumipy/test/integration/test_client.py,sha256=M4sF-Vv7RyUjb7vtyXCAxlfk1ESTtYEvCsViV7chgHU,9949
 lumipy/test/integration/test_direct_providers.py,sha256=SaC1iu7ZKLMF_2lSihmKPM27jRwwfxOXQDdHHKX8VMc,8363
 lumipy/test/integration/test_lumiflex.py,sha256=FM7r7YjYQD0vLNWXY25ceV5jEpFl0r6douAcj5KlBSI,12593
 lumipy/test/provider/__init__.py,sha256=GrfZvgfTjrRk6Y8niwJjY60E6DymOrRmuy--1K6Lzuk,148
@@ -379,8 +379,8 @@ lumipy/test/unit/provider_tests/test_provider_factory.py,sha256=ICHlEiYS-GvKFoI5
 lumipy/test/unit/provider_tests/test_provider_manager.py,sha256=-TT-3ZGpDsFKMz4efWIy7TGAUVtZ2gTDa67DiorIioc,13456
 lumipy/test/unit/queryjob_tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lumipy/test/unit/queryjob_tests/test_queryjob.py,sha256=1UE4-VuIkAE6vo0vogq3p2iXtTukiAPxOt5Uankx7c4,1542
-dve_lumipy_testing-1.0.389.dist-info/METADATA,sha256=B5ZLfAXOAy6doNYMg4IL8lS_lyVt7DwCAshuHMZ8vl4,11856
-dve_lumipy_testing-1.0.389.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-dve_lumipy_testing-1.0.389.dist-info/entry_points.txt,sha256=L7hRlqwmvzHMwaOQzygKLK-gx4k4e1q4Qz5m0DGihW8,46
-dve_lumipy_testing-1.0.389.dist-info/top_level.txt,sha256=DVww8LaQM3Xm0WOgo4JE0epePgCM1xGWWWxh7wuv-CY,7
-dve_lumipy_testing-1.0.389.dist-info/RECORD,,
+dve_lumipy_testing-1.0.391.dist-info/METADATA,sha256=QnilfDd1_YVc2EzxIUpMuI7fiu91rpjJIdEGCbgxzeo,14795
+dve_lumipy_testing-1.0.391.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+dve_lumipy_testing-1.0.391.dist-info/entry_points.txt,sha256=L7hRlqwmvzHMwaOQzygKLK-gx4k4e1q4Qz5m0DGihW8,46
+dve_lumipy_testing-1.0.391.dist-info/top_level.txt,sha256=DVww8LaQM3Xm0WOgo4JE0epePgCM1xGWWWxh7wuv-CY,7
+dve_lumipy_testing-1.0.391.dist-info/RECORD,,

lumipy/provider/max_version.py

@@ -1 +1 @@
-max_version_str = '1.18.242'
+max_version_str = '1.18.243'

lumipy/test/integration/test_client.py

@@ -239,7 +239,7 @@ class ClientTests(BaseIntTest):
         except Exception as e:
             # Currently throwing `pydantic.v1.error_wrappers.ValidationError` so I thought best to have a generic
             # catch here, I suspect this will be updated soon which could break this test
-            self.assertIn('value is not a valid enumeration member', str(e))
+            self.assertIn("The value 'Not_A_Binary' is not valid.", str(e))
 
     def test_certs_download(self):
         self.client.download_certs()