{"id":30117395,"url":"https://github.com/longcipher/orderly-sdk-py","last_synced_at":"2025-12-14T11:01:53.588Z","repository":{"id":208360626,"uuid":"703431278","full_name":"longcipher/orderly-sdk-py","owner":"longcipher","description":"Orderly.Network Async Python SDK","archived":false,"fork":false,"pushed_at":"2025-08-25T21:28:57.000Z","size":462,"stargazers_count":2,"open_issues_count":5,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-21T15:52:14.660Z","etag":null,"topics":["async","orderly","orderly-sdk","pdoc","poetry","rest","websocket","ws"],"latest_commit_sha":null,"homepage":"https://longcipher.github.io/orderly-sdk-py/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/longcipher.png","metadata":{"files":{"readme":".github/README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-10-11T08:28:45.000Z","updated_at":"2025-08-07T22:32:45.000Z","dependencies_parsed_at":"2023-12-07T06:30:51.837Z","dependency_job_id":"8168d993-a2d4-47e0-803b-e6c42694bb09","html_url":"https://github.com/longcipher/orderly-sdk-py","commit_stats":null,"previous_names":["akagi201/orderly-sdk-py","longcipher/orderly-sdk-py"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/longcipher/orderly-sdk-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longcipher%2Forderly-sdk-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longcipher%2Forderly-sdk-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longcipher%2Forderly-sdk-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longcipher%2Forderly-sdk-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/longcipher","download_url":"https://codeload.github.com/longcipher/orderly-sdk-py/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/longcipher%2Forderly-sdk-py/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27726940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","orderly","orderly-sdk","pdoc","poetry","rest","websocket","ws"],"created_at":"2025-08-10T10:43:02.222Z","updated_at":"2025-12-14T11:01:53.548Z","avatar_url":"https://github.com/longcipher.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setting up GitHub Pages for Orderly SDK Documentation\n\nThis guide explains how to set up GitHub Pages to automatically publish your pdoc-generated documentation.\n\n## 📋 Setup Steps\n\n### 1. Enable GitHub Pages\n\n1. Go to your repository settings: `https://github.com/longcipher/orderly-sdk-py/settings`\n2. Scroll down to the **Pages** section\n3. Under **Source**, select **GitHub Actions**\n4. Save the settings\n\n### 2. Configure Repository Permissions\n\n1. Go to **Settings** → **Actions** → **General**\n2. Under **Workflow permissions**, select **Read and write permissions**\n3. Check **Allow GitHub Actions to create and approve pull requests**\n4. Save the changes\n\n### 3. Set Up PyPI Publishing (Optional)\n\nTo enable automatic PyPI publishing when you create releases:\n\n1. Go to your PyPI account and create an API token:\n   - Visit: https://pypi.org/manage/account/token/\n   - Create a new token with scope for this project\n   \n2. Add the token to your GitHub repository secrets:\n   - Go to **Settings** → **Secrets and variables** → **Actions**\n   - Click **New repository secret**\n   - Name: `PYPI_API_TOKEN`\n   - Value: Your PyPI API token (starting with `pypi-`)\n\n## 🚀 How It Works\n\n### Documentation Workflow (`docs.yml`)\n\n- **Triggers**: Push to `master`/`main`, PRs, or manual dispatch\n- **What it does**:\n  1. Checks out the code\n  2. Sets up Python 3.13 and uv\n  3. Installs dependencies\n  4. Generates documentation with pdoc\n  5. Deploys to GitHub Pages\n\n### Publishing Workflow (`publish.yml`)\n\n- **Triggers**: Version tags (`v*`), releases, or manual dispatch  \n- **What it does**:\n  1. Builds the Python package\n  2. Runs quality checks\n  3. Publishes to PyPI (if secrets are configured)\n\n## 📖 Generated Documentation\n\nAfter the first successful run, your documentation will be available at:\n`https://longcipher.github.io/orderly-sdk-py/`\n\nThe documentation includes:\n- Complete API reference for all modules\n- Source code links\n- Search functionality\n- Responsive design with dark/light mode support\n- Custom styling optimized for API documentation\n\n## 🔧 Customization\n\n### Pdoc Configuration\n\nEdit `.pdoc.yml` to customize documentation generation:\n- Change docstring format\n- Enable/disable source code display\n- Modify search settings\n- Add custom footer text\n\n### Custom Styling\n\nAdd custom CSS in `.github/pdoc_templates/custom.css` for:\n- Brand colors and fonts\n- Layout modifications  \n- Additional responsive breakpoints\n- Enhanced code highlighting\n\n### Workflow Customization\n\nModify `.github/workflows/docs.yml` to:\n- Change trigger conditions\n- Add quality checks before deployment\n- Integrate with other documentation tools\n- Add notification steps\n\n## 📝 Tips\n\n1. **Documentation Quality**: Add comprehensive docstrings to all public methods and classes\n2. **Version Control**: Tag releases properly (`git tag v0.3.1`) to trigger publishing\n3. **Testing**: Use workflow dispatch to test documentation generation manually\n4. **Monitoring**: Check the Actions tab to monitor workflow runs\n\n## 🐛 Troubleshooting\n\n### Common Issues\n\n**Documentation not updating?**\n- Check if GitHub Pages is enabled and set to \"GitHub Actions\"\n- Verify workflow permissions are set correctly\n- Look at the Actions tab for error logs\n\n**PyPI publishing failing?**\n- Ensure `PYPI_API_TOKEN` secret is set correctly\n- Check if the token has the right scope\n- Verify the package version is not already published\n\n**Styling not applied?**\n- Check if custom CSS files exist in the expected locations\n- Verify HTML generation completes successfully\n- Look for CSS-related errors in workflow logs\n\n### Getting Help\n\n- Check workflow logs in the Actions tab\n- Review pdoc documentation: https://pdoc.dev\n- Open an issue if you encounter persistent problems\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongcipher%2Forderly-sdk-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flongcipher%2Forderly-sdk-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flongcipher%2Forderly-sdk-py/lists"}