From 9867edf4850c63da15b85811fb1ccba9446773c1 Mon Sep 17 00:00:00 2001 From: smatzkel-newrelic <84398037+smatzkel-newrelic@users.noreply.github.com> Date: Mon, 6 Mar 2023 13:48:02 +0200 Subject: [PATCH] Add missing fields to pyproject.toml (#3) --- README.md | 8 +------- README_agent.md | 44 -------------------------------------------- pyproject.toml | 5 ++++- 3 files changed, 5 insertions(+), 52 deletions(-) delete mode 100644 README_agent.md diff --git a/README.md b/README.md index ed3034c..1fdb72a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,5 @@ - - - - - New Relic open source - Experimental - - +[![Community Project header](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Project.png)](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#category-community-project) # OpenAI Observability diff --git a/README_agent.md b/README_agent.md deleted file mode 100644 index d8b8b7c..0000000 --- a/README_agent.md +++ /dev/null @@ -1,44 +0,0 @@ -[![Community Project header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Project.png)](https://opensource.newrelic.com/oss-category/#community-project) - -# [Name of Project] [build badges go here when available] - ->[Brief description - what is the software and what value does it provide? How often should users expect to get releases? How is versioning set up? What are some next phases for the project or how will it evolve?] - -## Installing and using [project name] - -> [Link to the relevant information for this agent on docs.newrelic.com. Create a bulleted list with links to install, usage, and getting started info on docs. Avoid duplicating information from docs in the open source content to ensure there's no inconsistency between the two.] - - -## Building - ->[**Optional** - Include this section if users will need to follow specific instructions to build the software from source. Be sure to include any third-party build dependencies that need to be installed separately. As mentioned, link to docs for install info that's already included there. Remove this section if it's not needed.] - -## Testing - ->[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.] - -## Support - -New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here: - ->[Add the url for the support thread here: discuss.newrelic.com] - -## Contribute - -We encourage your contributions to improve [project name]! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. - -If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com. - -**A note about vulnerabilities** - -As noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. - -If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). - -If you would like to contribute to this project, review [these guidelines](./CONTRIBUTING.md). - -To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to [Project Name](). - -## License -[Project name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License. ->[If applicable: The [project name] also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third-party notices document.] diff --git a/pyproject.toml b/pyproject.toml index 73d81df..6b74738 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,11 @@ [tool.poetry] name = "nr-openai-observability" version = "0.1.0" -description = "" +description = "A lightweight tool to monitor your OpenAI workload." authors = ["AIR "] +repository = "https://github.com/newrelic/nr-openai-observability" +readme = "README.md" +homepage = "https://newrelic.com/instant-observability/openai" [tool.poetry.dependencies] python = "^3.7.1"