Skip to content

Commit 44222d4

Browse files
jdrhynejdrhyne
committed
docs: enhance GitHub repository setup
- Add comprehensive GITHUB_ABOUT.md with repository settings guide - Add badges to README (Python version, coverage, license, etc.) - Create issue templates for bugs, features, and API questions - Add issue template configuration with helpful links - Include recommended topics/tags for better discoverability These additions make the repository more professional and easier for users to interact with and contribute to the project.
1 parent b5c7d0b commit 44222d4

File tree

6 files changed

+250
-0
lines changed

6 files changed

+250
-0
lines changed

‎.github/ISSUE_TEMPLATE/api_question.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: API Question
3+
about: Ask a question about API usage or capabilities
4+
title: '[QUESTION] '
5+
labels: 'question, api-question'
6+
assignees: ''
7+
8+
---
9+
10+
**What are you trying to accomplish?**
11+
Describe what you're trying to do with the API.
12+
13+
**What have you tried?**
14+
```python
15+
# Show your current code
16+
```
17+
18+
**What's not working?**
19+
Describe what's happening vs what you expected.
20+
21+
**Relevant documentation**
22+
- Have you checked the [README](https://github.com/jdrhyne/nutrient-dws-client-python/blob/main/README.md)?
23+
- Have you checked [SUPPORTED_OPERATIONS](https://github.com/jdrhyne/nutrient-dws-client-python/blob/main/SUPPORTED_OPERATIONS.md)?
24+
25+
**Environment:**
26+
- nutrient-dws version: [e.g. 1.0.0]
27+
- Python version: [e.g. 3.9.0]
28+
29+
**Additional context**
30+
Any other details that might be helpful.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
```python
16+
# Your code here
17+
```
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Actual behavior**
23+
What actually happened.
24+
25+
**Error messages**
26+
```
27+
# Full error traceback
28+
```
29+
30+
**Environment:**
31+
- OS: [e.g. Ubuntu 20.04, Windows 10, macOS 12.0]
32+
- Python version: [e.g. 3.9.0]
33+
- nutrient-dws version: [e.g. 1.0.0]
34+
- Installation method: [pip, source]
35+
36+
**Additional context**
37+
Add any other context about the problem here.
38+
39+
**Possible solution**
40+
If you have an idea of how to fix this issue, please describe it.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Nutrient Documentation
4+
url: https://www.nutrient.io/guides/
5+
about: Check the official Nutrient documentation
6+
- name: API Status
7+
url: https://status.nutrient.io/
8+
about: Check if the API is experiencing issues
9+
- name: Commercial Support
10+
url: https://www.nutrient.io/contact/
11+
about: For commercial support inquiries

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Example usage**
20+
```python
21+
# Show how you'd like to use this feature
22+
client = NutrientClient(api_key="...")
23+
# Your proposed API
24+
```
25+
26+
**Additional context**
27+
Add any other context or screenshots about the feature request here.
28+
29+
**Would you be willing to submit a PR?**
30+
- [ ] Yes, I'd be happy to submit a PR
31+
- [ ] No, but I'm happy to test it

‎GITHUB_ABOUT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# GitHub Repository Settings
2+
3+
## About Section
4+
5+
### Description
6+
Official Python client library for Nutrient Document Web Services API - PDF processing, OCR, watermarking, and document manipulation with automatic Office format conversion
7+
8+
### Website
9+
https://www.nutrient.io/
10+
11+
### Topics (Tags)
12+
Add these topics to make your repository more discoverable:
13+
14+
**Core Technologies:**
15+
- `python`
16+
- `python3`
17+
- `api-client`
18+
- `sdk`
19+
- `rest-api`
20+
21+
**PDF & Document Processing:**
22+
- `pdf`
23+
- `pdf-processing`
24+
- `pdf-manipulation`
25+
- `pdf-generation`
26+
- `document-processing`
27+
- `document-conversion`
28+
- `document-automation`
29+
30+
**Features:**
31+
- `ocr`
32+
- `optical-character-recognition`
33+
- `watermark`
34+
- `pdf-merge`
35+
- `pdf-rotation`
36+
- `office-conversion`
37+
- `docx-to-pdf`
38+
39+
**Brand/Product:**
40+
- `nutrient`
41+
- `pspdfkit`
42+
- `nutrient-api`
43+
- `dws`
44+
45+
**Development:**
46+
- `type-hints`
47+
- `async-ready`
48+
- `well-tested`
49+
- `developer-tools`
50+
51+
## Recommended Repository Settings
52+
53+
### ✅ Features to Enable:
54+
- **Issues** - For bug reports and feature requests
55+
- **Discussions** - For Q&A and community support
56+
- **Wiki** - For additional documentation (optional)
57+
- **Projects** - For tracking development roadmap
58+
59+
### 🔧 Settings:
60+
- **Allow forking** - Enable community contributions
61+
- **Sponsorships** - If you want to accept sponsorships
62+
- **Preserve this repository** - For long-term stability
63+
64+
### 📌 Pinned Issues:
65+
Consider pinning:
66+
1. "Getting Started Guide"
67+
2. "API Key Request"
68+
3. "Roadmap & Feature Requests"
69+
70+
### 🏷️ Issue Labels:
71+
Add these custom labels:
72+
- `api-question` - Questions about API usage
73+
- `office-conversion` - Related to DOCX/XLSX/PPTX conversion
74+
- `performance` - Performance-related issues
75+
- `security` - Security-related issues
76+
77+
### 📋 Issue Templates:
78+
Consider adding templates for:
79+
1. Bug Report
80+
2. Feature Request
81+
3. API Question
82+
4. Documentation Issue
83+
84+
## Social Preview
85+
86+
Consider adding a social preview image that shows:
87+
- Nutrient DWS logo
88+
- "Python Client Library"
89+
- Key features (PDF, OCR, Watermark, etc.)
90+
- Code snippet example
91+
92+
## Repository Insights to Highlight
93+
94+
### In your README badges:
95+
```markdown
96+
![Python](https://img.shields.io/badge/python-3.8+-blue.svg)
97+
![Coverage](https://img.shields.io/badge/coverage-92%25-brightgreen.svg)
98+
![License](https://img.shields.io/badge/license-MIT-green.svg)
99+
![PyPI](https://img.shields.io/pypi/v/nutrient-dws.svg)
100+
```
101+
102+
### Quick Stats:
103+
- **Language**: Python 100%
104+
- **Test Coverage**: 92.46%
105+
- **Dependencies**: Minimal (just `requests`)
106+
- **Python Support**: 3.8, 3.9, 3.10, 3.11, 3.12
107+
- **API Operations**: 7 supported operations
108+
- **Development Time**: Rapid implementation with comprehensive testing
109+
110+
## Suggested Bio/Tagline Options
111+
112+
1. "🚀 Transform documents at scale with Nutrient's Python SDK - PDF processing made simple"
113+
114+
2. "📄 Enterprise-ready Python client for Nutrient DWS - Convert, OCR, watermark, and manipulate PDFs with ease"
115+
116+
3. "🔧 The official Python SDK for Nutrient Document Web Services - Your toolkit for PDF automation"
117+
118+
4. "⚡ Fast, reliable document processing in Python - Powered by Nutrient's cloud API"
119+
120+
## SEO Keywords for Better Discovery
121+
122+
Include these naturally in your README:
123+
- Python PDF library
124+
- Document automation API
125+
- PDF OCR Python
126+
- Office to PDF conversion
127+
- PDF watermarking Python
128+
- Document processing SDK
129+
- Nutrient API Python
130+
- Cloud PDF API
131+
- PDF manipulation library
132+
- Enterprise document processing

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Nutrient DWS Python Client
22

3+
[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
4+
[![Coverage](https://img.shields.io/badge/coverage-92%25-brightgreen.svg)](https://github.com/jdrhyne/nutrient-dws-client-python/actions)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
7+
[![PyPI version](https://img.shields.io/pypi/v/nutrient-dws.svg)](https://pypi.org/project/nutrient-dws/)
8+
39
A Python client library for the [Nutrient Document Web Services (DWS) API](https://www.nutrient.io/). This library provides a Pythonic interface to interact with Nutrient's document processing services, supporting both Direct API calls and Builder API workflows.
410

511
## Features

0 commit comments

Comments
 (0)