Skip to content

Commit

Permalink
setup skeleton and packaging, derived from patterns found via lucidrains
Browse files Browse the repository at this point in the history
  • Loading branch information
codycollier committed Jul 30, 2022
1 parent 47a8c96 commit 10739a5
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 1 deletion.
38 changes: 38 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@


# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
release:
types: [published]

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# venra
## venra

[![PyPI version](https://badge.fury.io/py/venra.svg)](https://badge.fury.io/py/venra)


### Install

```bash
$ pip install venra
```

### Usage


```python

import venra

print(venra.stars)
```
31 changes: 31 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
from setuptools import setup, find_packages
exec(open('venra/version.py').read())

setup(
name = 'venra',
packages = find_packages(exclude=[]),
version = __version__,
license='MIT',
description = 'venra',
author = 'Cody Collier',
author_email = '[email protected]',
long_description_content_type = 'text/markdown',
url = 'https://github.com/codycollier/venra',
keywords = [
'artificial intelligence',
'information retrieval',
'machine learning',
'search',
],
install_requires=[
'packaging',
'requests',
],
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'Topic :: Scientific/Engineering :: Artificial Intelligence',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3.6',
],
)
15 changes: 15 additions & 0 deletions venra/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


stars = """
.. . * . . * *. . . . . . * ` .
* . . ` ` * . . . . ** .* * . `
. . . .. * . * . .
. ..` . *. ** . * * . . . * `
. ` . .. . . . .. . `. . * * . .
* .. . ` `* ` * `. . ` .. . . * ..
.. . . * . * * . * * .
* * . . *` **. .* *.. . *. . ` . . .
.. * . .* . . * . .*. ..* .. `
` . * * . . . . . * .. . . *. `
"""

1 change: 1 addition & 0 deletions venra/version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = '0.0.1'

0 comments on commit 10739a5

Please sign in to comment.