Skip to content

Commit e895a71

Browse files
Gameli LadzekpoGameli Ladzekpo
authored andcommitted
Add LICENSE, GitHub setup instructions, and update repository URLs
1 parent d12e1c9 commit e895a71

File tree

3 files changed

+118
-2
lines changed

3 files changed

+118
-2
lines changed

GITHUB_SETUP.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# GitHub Setup Instructions
2+
3+
## Step 1: Create GitHub Repository
4+
5+
1. Go to: https://github.com/new
6+
2. Repository name: `surfa-ingest`
7+
3. Description: `Official Python SDK for Surfa Analytics - Ingest live AI/LLM traffic events`
8+
4. Visibility: **Public**
9+
5. **DO NOT** initialize with README, .gitignore, or license (we already have them)
10+
6. Click "Create repository"
11+
12+
## Step 2: Push to GitHub
13+
14+
After creating the repo, run these commands:
15+
16+
```bash
17+
cd "/Users/gameliladzekpo/Surfa Monorepo/surfa-ingest"
18+
19+
# Add remote (replace 'gamladz' with your GitHub username if different)
20+
git remote add origin https://github.com/gamladz/surfa-ingest.git
21+
22+
# Push to GitHub
23+
git branch -M main
24+
git push -u origin main
25+
```
26+
27+
## Step 3: Configure Repository Settings
28+
29+
### Add Topics (for discoverability)
30+
Go to: https://github.com/gamladz/surfa-ingest
31+
32+
Click "⚙️ Settings" → Scroll to "Topics"
33+
34+
Add these topics:
35+
- `python`
36+
- `sdk`
37+
- `analytics`
38+
- `observability`
39+
- `llm`
40+
- `ai`
41+
- `mcp`
42+
- `monitoring`
43+
- `event-tracking`
44+
45+
### Add Description
46+
In the main repo page, click "⚙️" next to "About" and add:
47+
- **Description**: Official Python SDK for Surfa Analytics - Ingest live AI/LLM traffic events
48+
- **Website**: https://pypi.org/project/surfa-ingest/
49+
- **Topics**: (already added above)
50+
51+
### Enable Discussions (Optional)
52+
Settings → Features → Check "Discussions"
53+
54+
## Step 4: Add GitHub Badge to PyPI
55+
56+
The PyPI page will automatically show the GitHub link once you add it to pyproject.toml (already done).
57+
58+
## Step 5: Create Release
59+
60+
1. Go to: https://github.com/gamladz/surfa-ingest/releases/new
61+
2. Tag version: `v0.1.0`
62+
3. Release title: `v0.1.0 - Initial Release`
63+
4. Description:
64+
```markdown
65+
## 🎉 Initial Release
66+
67+
First public release of the Surfa Ingest SDK!
68+
69+
### Features
70+
- Event buffering and batching
71+
- Session management
72+
- Context manager support
73+
- Runtime metadata capture
74+
- HTTP API integration with retry logic
75+
- Event validation
76+
77+
### Installation
78+
```bash
79+
pip install surfa-ingest
80+
```
81+
82+
### Links
83+
- 📦 PyPI: https://pypi.org/project/surfa-ingest/
84+
- 📚 Documentation: https://docs.surfa.dev
85+
```
86+
5. Click "Publish release"
87+
88+
## Done! 🎉
89+
90+
Your SDK is now:
91+
- ✅ Published on PyPI
92+
- ✅ Open source on GitHub
93+
- ✅ Discoverable by developers
94+
- ✅ Ready for contributions

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Surfa
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ dev = [
4343
[project.urls]
4444
Homepage = "https://surfa.dev"
4545
Documentation = "https://docs.surfa.dev"
46-
Repository = "https://github.com/yourusername/surfa"
47-
Issues = "https://github.com/yourusername/surfa/issues"
46+
Repository = "https://github.com/gamladz/surfa-ingest"
47+
Issues = "https://github.com/gamladz/surfa-ingest/issues"
48+
PyPI = "https://pypi.org/project/surfa-ingest/"
4849

4950
[tool.setuptools.packages.find]
5051
where = ["."]

0 commit comments

Comments
 (0)