Skip to content

Commit

Permalink
Bump version for docs release
Browse files Browse the repository at this point in the history
  • Loading branch information
erichare committed Oct 30, 2023
1 parent 5bf400f commit 9fabd5d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## AstraPy
# AstraPy

AstraPy is a Pythonic SDK for [DataStax Astra](https://astra.datastax.com) and [Stargate](https://stargate.io/)

### Resources
## Resources

- [DataStax Astra](https://astra.datastax.com)
- [Stargate](https://stargate.io/)

### Getting Started
## Getting Started

Install AstraPy

```shell
```bash
pip install astrapy
```

Expand Down Expand Up @@ -100,23 +100,23 @@ astra_db_collection.find_one({"name": "potato"}) # Not found
astra_db_collection.find_one({"name": "Coded Cleats Copy"})
```

#### More Information
### More Information

Check out the [notebook](https://colab.research.google.com/github/synedra/astra_vector_examples/blob/main/notebook/vector.ipynb#scrollTo=f04a1806) which has examples for finding and inserting information into the database, including vector commands.

Take a look at the [astra db tests](https://github.com/datastax/astrapy/blob/master/tests/astrapy/test_db.py) for specific endpoint examples.

#### Using the Ops Client
### Using the Ops Client

You can use the Ops client to work with the Astra DevOps API. Check the [devops tests](https://github.com/datastax/astrapy/blob/master/tests/astrapy/test_ops.py)

### For Developers
## For Developers

#### Testing
### Testing

Ensure you provide all required environment variables:

```
```bash
export ASTRA_DB_ID="..."
export ASTRA_DB_REGION="..."
export ASTRA_DB_APPLICATION_TOKEN="..."
Expand All @@ -127,6 +127,6 @@ export ASTRA_CLIENT_SECRET="..."

then you can run:

```
```bash
PYTHONPATH=. pytest
```
2 changes: 1 addition & 1 deletion astrapy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
__version__ = "0.5.1"
__version__ = "0.5.2"
3 changes: 2 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
[metadata]
description-file = README.md
description_file = README.md
description_file_content_type = text/markdown

0 comments on commit 9fabd5d

Please sign in to comment.