Merge pull request #31 from mozilla-ai/agonzales/RD2024-58

adding publishing info for public and test pypi

CONTRIBUTING.md

@@ -78,3 +78,40 @@ To do so, follow the steps:
     but does not install its entrypoint in the environment path.
 
 An example of this workflow can be found in the `examples/dev_workflow.ipynb` notebook.
+
+
+# Publishing
+
+This is only relevant for maintainers / Mozilla.ai internal people.
+Use the local installable package workflow above for iteration locally.
+
+## Setup
+
+This only needs to be done once.
+You should have access to the API key via 1password. Make sure the 1password cli is installed (`brew install 1password-cli`).
+
+Set up poetry to use the key(s):
+
+```
+poetry config repositories.testpypi https://test.pypi.org/legacy/
+poetry config pypi-token.testpypi $(op read "op://<VAULT>/PyPI-test/pypi/api_key")
+poetry config pypi-token.pypi $(op read "op://<VAULT>/PyPI/pypi/api_key")
+```
+
+## Test 
+
+Then build and publish to PyPI Test:
+
+```
+
+poetry publish --repository testpypi --dry-run --build
+poetry publish --repository testpypi --build
+```
+
+## Publish
+
+When you're ready, run:
+
+```
+poetry publish --build
+```

README.md

@@ -16,7 +16,7 @@ cluster environment (Ray cluster is running 3.10.8).
 ### Installation
 
 ```
-pip install flamingo (TODO-name update)
+pip install mzai-flamingo
 ```
 
 See the [contributing](CONTRIBUTING.md) guide for more information on development workflows and/or building locally.

pyproject.toml

@@ -3,12 +3,17 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-name = "flamingo"
+name = "mzai-flamingo"
 version = "0.1.0"
 description = "Ray-centric job library for training and evaluation."
 repository = "https://github.com/mozilla-ai/flamingo"
 readme = "README.md"
-authors = []
+authors = [
+    "Sean Friedowitz <[email protected]>",
+    "Aaron Gonzales <[email protected]>",
+    "Vicki Boykis <[email protected]>",
+]
+license = "Apache-2.0"
 packages = [{ include = "flamingo", from = "src" }]
 
 [tool.poetry.dependencies]