Skip to content

Commit 51d4e8d

Browse files
committed
chore: point readme to docs page
1 parent fe31452 commit 51d4e8d

1 file changed

Lines changed: 1 addition & 62 deletions

File tree

README.md

Lines changed: 1 addition & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -39,65 +39,4 @@ import devcycle_python_sdk
3939

4040
## Usage
4141

42-
### Getting All Features
43-
```python
44-
try:
45-
# Get all features by key for user data
46-
api_response = dvc.all_features(user)
47-
print(api_response)
48-
except ApiException as e:
49-
print("Exception when calling DVCClient->all_features: %s\n" % e)
50-
51-
```
52-
53-
### Get and Use Variable by Key
54-
To get values from your Variables, `all_variables()` is used to fetch variable values using the identifier `key` coupled with a default value. The default value can be of type string, boolean, number, or object.
55-
56-
```python
57-
key = 'key-test' # str | Variable key
58-
59-
try:
60-
# Get variable by key for user data
61-
variable = dvc.variable(user, key, 'default-value')
62-
print("Variable value is: ", variable.value)
63-
except ApiException as e:
64-
print("Exception when calling DVCClient->variable: %s\n" % e)
65-
66-
```
67-
68-
### Getting All Variables
69-
To get values from your Variables, `all_variables()` is used to fetch variable values using the identifier `key` coupled with a default value. The default value can be of type string, boolean, number, or object.
70-
71-
```python
72-
key = 'key-test' # str | Variable key
73-
74-
try:
75-
# Get all variables for user data
76-
variables = dvc.all_variables(user)
77-
print(variables)
78-
except ApiException as e:
79-
print("Exception when calling DVCClient->all_variables: %s\n" % e)
80-
```
81-
82-
### Track Event
83-
To POST custom event for a user
84-
```python
85-
86-
event = Event(
87-
type="customEvent",
88-
target="somevariable.key"
89-
)
90-
try:
91-
# Post events to DevCycle for user
92-
api_response = dvc.track(user, event)
93-
print(api_response)
94-
except ApiException as e:
95-
print("Exception when calling DVCClient->track: %s\n" % e)
96-
```
97-
98-
99-
#### About this package
100-
101-
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
102-
103-
- Package version: 1.0.0
42+
To find usage documentation, visit our [docs](https://docs.devcycle.com/docs/sdk/server-side-sdks/python#usage).

0 commit comments

Comments
 (0)