Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/metadata #619

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ build:
- cp -r demos docs/source/demos
- cp README.md docs/source/README.md
- cp ARCHITECTURE.md docs/source/ARCHITECTURE.md
- cp CONTRIBUTE.md docs/source/CONTRIBUTE.md
- cp CONTRIBUTING.md docs/source/CONTRIBUTING.md
- cp DEVELOP.md docs/source/DEVELOP.md

# build html
Expand Down
2 changes: 1 addition & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architecture

This document should help get started with modifying code. See also [develop.md](DEVELOP.md) for developer commands and [CONTRIBUTE.md](CONTRIBUTE.md) for community guidelines.
This document should help get started with modifying code. See also [develop.md](DEVELOP.md) for developer commands and [CONTRIBUTING.md](CONTRIBUTING.md) for community guidelines.

## Client/Server Wrangling Tool

Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and all PyGraphistry-specific breaking changes are explictly noted here.

## [Development]

## [0.35.3 - 2024-12-13]

### Docs

* Rename CONTRIBUTE.md to CONTRIBUTING.md to match OSS standards (snyk)
* setup.py: add project_urls
* Add FUNDING.md
* Add CODE_OF_CONDUCT.md

## [0.35.2 - 2024-12-13]

### Docs

* Python remote mode notebook: Fixed engine results
Expand Down
29 changes: 29 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# PyGraphistry Code of Conduct

PyGraphistry is an open-source project built on collaboration and respect. This Code of Conduct lays out how we expect everyone to interact so we can maintain a positive and productive environment.

## How We Work Together

- Treat others decently—listen, respond constructively, and keep it professional.
- Stay focused on ideas and solutions, not personal disagreements.
- Be helpful, especially to newcomers or those asking for clarification.

## What’s Not Okay

Harassment, personal attacks, or sharing private information without permission are not okay. Be respectful and avoid language or behavior that alienates or disrupts others.

## Where This Applies

This Code of Conduct applies to all spaces related to the PyGraphistry project, like GitHub repositories, pull request discussions, and private communications. If you’re representing PyGraphistry in public (e.g., social media or events), we expect the same standards of behavior.

## If There’s a Problem

If you see or experience behavior that doesn’t align with this Code of Conduct, let us know at **[oss@graphistry.com](mailto:oss@graphistry.com)**. We’ll handle it privately and work together to figure out the next steps.

## What Happens Next

Breaking the rules? We’ll handle it case by case. You might get a warning, a temporary ban, or permanent removal from the project.

---

Thanks for being part of PyGraphistry!
File renamed without changes.
2 changes: 1 addition & 1 deletion DEVELOP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Development Setup

See also [CONTRIBUTE.md](CONTRIBUTE.md) and [ARCHITECTURE.md](ARCHITECTURE.md)
See also [CONTRIBUTING.md](CONTRIBUTING.md) and [ARCHITECTURE.md](ARCHITECTURE.md)

Development is setup for local native and containerized Python coding & testing, and with automatic GitHub Actions for CI + CD. The server tests are like the local ones, except against a wider test matrix of environments.

Expand Down
31 changes: 31 additions & 0 deletions FUNDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Supporting PyGraphistry

PyGraphistry is an open-source Python project proudly sponsored by [Graphistry](https://www.graphistry.com), a leader in GPU-accelerated visual graph analytics and AI. Your support helps us maintain and expand PyGraphistry as a free and open tool for the data science and graph analytics community.

## How to Support

If your organization uses PyGraphistry or benefits from GPU-accelerated analytics, please consider supporting this project indirectly by becoming a customer or directly such as through code contributions and sponsored development. Reach out to the Graphistry team to discuss sponsorship opportunities:

- Email: [oss@graphistry.com](mailto:oss@graphistry.com)
- Website: [Graphistry Sponsorship](https://www.graphistry.com)

## Why Support PyGraphistry?

Your contributions help us:
- Keep PyGraphistry maintained, up-to-date, and secure
- Be responsive to user feedback, bug reports, and feature requests
- Advance PyGraphistry's capabilities, performance, and usability
- Ensure the project remains free and open-source
- Support the community through documentation, tutorials, and responsive issue tracking

## Corporate Sponsorship Opportunities

We welcome sponsorships from companies that depend on PyGraphistry for analytics, visualization, and AI. Sponsorships may include:
- Recognition in PyGraphistry's release notes and documentation
- Early access to new features and roadmap acceleration
- Collaboration opportunities with the Graphistry team

## Thank You

A huge thanks to the Graphistry team and community for supporting PyGraphistry, and to all our users for their continued support!

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,5 +207,5 @@ Explore [10 Minutes to PyGraphistry](https://pygraphistry.readthedocs.io/en/late

## Contribute

See [CONTRIBUTE](https://pygraphistry.readthedocs.io/en/latest/CONTRIBUTE.html) and [DEVELOP](https://pygraphistry.readthedocs.io/en/latest/DEVELOP.html) for participating in PyGraphistry development, or reach out to our team
See [CONTRIBUTING](https://pygraphistry.readthedocs.io/en/latest/CONTRIBUTING.html) and [DEVELOP](https://pygraphistry.readthedocs.io/en/latest/DEVELOP.html) for participating in PyGraphistry development, or reach out to our team

2 changes: 1 addition & 1 deletion docs/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ COPY docs/source /docs/source
COPY demos /docs/source/demos
COPY README.md /docs/source/README.md
COPY ARCHITECTURE.md /docs/source/ARCHITECTURE.md
COPY CONTRIBUTE.md /docs/source/CONTRIBUTE.md
COPY CONTRIBUTING.md /docs/source/CONTRIBUTING.md
COPY DEVELOP.md /docs/source/DEVELOP.md

# Step 6: Set the working directory for Sphinx to the `source/` folder
Expand Down
2 changes: 1 addition & 1 deletion docs/source/graphistry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
support
ecosystem
ARCHITECTURE.md
CONTRIBUTE.md
CONTRIBUTING.md
DEVELOP.md

16 changes: 16 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,5 +123,21 @@ def unique_flatten_dict(d):
'Topic :: Software Development :: Widget Sets',
'Topic :: System :: Distributed Computing'
],
project_urls = {
"Homepage": "https://www.graphistry.com",
"Repository": "https://github.com/graphistry/pygraphistry",
"Documentation": "https://pygraphistry.readthedocs.io/",
"Changelog": "https://github.com/graphistry/pygraphistry/blob/master/CHANGELOG.md",
"Issues": "https://github.com/graphistry/pygraphistry/issues",
"Funding": "https://www.graphistry.com",
"Download": "https://pypi.org/project/graphistry/#files",
"Slack": "https://graphistry-community.slack.com",
"Twitter": "https://twitter.com/graphistry",
"LinkedIn": "https://www.linkedin.com/company/graphistry",
"Contributing": "https://github.com/graphistry/pygraphistry/blob/master/CONTRIBUTING.md",
"License": "https://github.com/graphistry/pygraphistry/blob/main/LICENSE.txt",
"Code of Conduct": "https://github.com/graphistry/pygraphistry/blob/main/CODE_OF_CONDUCT.md",
"Support": "https://www.graphistry.com/support",
},
keywords=['cugraph', 'cudf', 'cuml', 'dask', 'Databricks', 'GFQL', 'GPU', 'Graph', 'graphviz', 'GraphX', 'Gremlin', 'igraph', 'Jupyter', 'Neo4j', 'Neptune', 'Network', 'NetworkX', 'Notebook', 'OpenSearch', 'Pandas', 'Plot', 'RAPIDS', 'RDF', 'Splunk', 'Spark', 'SQL', 'Tinkerpop', 'UMAP', 'Visualization', 'Torch', 'DGL', 'GNN']
)
Loading