Merge pull request #4 from vertexcover-io/refactor/remove-relative-imports

Refact: Rename project and minor changes

Author: amankumarsingh77

.github/workflows/release.yml

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+  pull-requests: write
+ 
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Extract tag version
+        id: tag_version
+        run: |
+          echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+
+      - name: Build package
+        run: uv build
+
+      - name: Generate changelog
+        id: changelog
+        uses: mikepenz/release-changelog-builder-action@v4
+        with:
+          configuration: ".github/changelog_config.json"
+          toTag: ${{ github.ref_name }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update CHANGELOG.md
+        run: |
+          # Create new changelog entry
+          echo "## [${{ github.ref_name }}] - $(date +%Y-%m-%d)" > temp_changelog.md
+          echo "" >> temp_changelog.md
+          echo "${{ steps.changelog.outputs.changelog }}" >> temp_changelog.md
+          echo "" >> temp_changelog.md
+
+          # Prepend new entry to existing changelog (after header)
+          head -n 7 CHANGELOG.md > new_changelog.md
+          cat temp_changelog.md >> new_changelog.md
+          tail -n +8 CHANGELOG.md >> new_changelog.md
+          mv new_changelog.md CHANGELOG.md
+          rm temp_changelog.md
+
+      - name: Commit updated CHANGELOG.md
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git stash push -m "temp changelog changes"
+          git checkout main
+          git stash pop
+          git add CHANGELOG.md
+          git commit -m "chore: update CHANGELOG.md for ${{ github.ref_name }}" || exit 0
+          git push origin main
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ steps.tag_version.outputs.VERSION }}
+          body: ${{ steps.changelog.outputs.changelog }}
+          files: |
+            dist/*
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: uv publish

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to `linkedin-mcp`
+# Contributing to `linkedin-spider`
 
 Contributions are welcome, and they are greatly appreciated!
 Every little bit helps, and credit will always be given.
@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ## Report Bugs
 
-Report bugs at https://github.com/amankumarsingh77/linkedin-mcp/issues
+Report bugs at https://github.com/vertexcover-io/linkedin-spider/issues
 
 If you are reporting a bug, please include:
 
@@ -29,11 +29,11 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to
 
 ## Write Documentation
 
-linkedin-mcp could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+linkedin-spider could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ## Submit Feedback
 
-The best way to send feedback is to file an issue at https://github.com/amankumarsingh77/linkedin-mcp/issues.
+The best way to send feedback is to file an issue at https://github.com/vertexcover-io/linkedin-spider/issues.
 
 If you are proposing a new feature:
 
@@ -44,22 +44,22 @@ If you are proposing a new feature:
 
 # Get Started!
 
-Ready to contribute? Here's how to set up `linkedin-mcp` for local development.
+Ready to contribute? Here's how to set up `linkedin-spider` for local development.
 Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.
 
-1. Fork the `linkedin-mcp` repo on GitHub.
+1. Fork the `linkedin-spider` repo on GitHub.
 
 2. Clone your fork locally:
 
 ```bash
 cd <directory_in_which_repo_should_be_created>
-git clone git@github.com:YOUR_NAME/linkedin-mcp.git
+git clone git@github.com:vertexcover-io/linkedin-spider.git
 ```
 
 3. Now we need to install the environment. Navigate into the directory
 
 ```bash
-cd linkedin-mcp
+cd linkedin-spider
 ```
 
 Then, install and activate the environment with:
@@ -68,23 +68,37 @@ Then, install and activate the environment with:
 uv sync
 ```
 
-4. Install pre-commit to run linters/formatters at commit time:
+4. Set up environment variables for authentication. Create a `.env` file in the project root:
+
+```bash
+cp .env.example .env
+# Edit .env with your LinkedIn credentials
+```
+
+**Example .env file:**
+```env
+LINKEDIN_EMAIL=your_email@example.com
+LINKEDIN_PASSWORD=your_password
+HEADLESS=true
+```
+
+5. Install pre-commit to run linters/formatters at commit time:
 
 ```bash
 uv run pre-commit install
 ```
 
-5. Create a branch for local development:
+6. Create a branch for local development:
 
 ```bash
 git checkout -b name-of-your-bugfix-or-feature
 ```
 
 Now you can make your changes locally.
 
-6. Don't forget to add test cases for your added functionality to the `tests` directory.
+7. Don't forget to add test cases for your added functionality to the `tests` directory.
 
-7. When you're done making changes, check that your changes pass the formatting tests.
+8. When you're done making changes, check that your changes pass the formatting tests.
 
 ```bash
 make check
@@ -96,15 +110,15 @@ Now, validate that all unit tests are passing:
 make test
 ```
 
-9. Before raising a pull request you should also run tox.
-   This will run the tests across different versions of Python:
+9. (Optional) For additional validation, you can run the MCP server locally to test your changes:
 
 ```bash
-tox
-```
+# Test the CLI
+make run-cli
 
-This requires you to have multiple versions of python installed.
-This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
+# Test the MCP server
+make run-mcp
+```
 
 10. Commit your changes and push your branch to GitHub:
 
@@ -116,6 +130,21 @@ git push origin name-of-your-bugfix-or-feature
 
 11. Submit a pull request through the GitHub website.
 
+## Available Make Commands
+
+For your convenience, here are the available make commands:
+
+```bash
+make help          # Show all available commands
+make install       # Install dev dependencies and pre-commit hooks
+make check         # Run code quality tools (linting, type checking)
+make test          # Run tests with pytest
+make build         # Build wheel file
+make clean         # Clean build artifacts and cache
+make run-cli       # Run LinkedIn spider CLI
+make run-mcp       # Run LinkedIn spider MCP server
+```
+
 # Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:

Makefile

@@ -27,11 +27,11 @@ clean-build:
 
 .PHONY: run-cli
 run-cli:
-	@uv run linkedin_scraper_cli
+	@uv run linkedin-spider-cli
 
 .PHONY: run-mcp
 run-mcp:
-	@uv run linkedin_scraper_mcp
+	@uv run linkedin-spider-mcp
 
 .PHONY: dev-install
 dev-install: install

README.md

@@ -1,11 +1,11 @@
-# linkedin-scraper-mcp
+# linkedin-spider
 
-Effortless LinkedIn scraping with zero detection. Extract, export, and automate your LinkedIn data.
+Effortless Linkedin scraping with zero detection. Extract, export, and automate your Linkedin data.
 
 
 ## Features
 
-- Search LinkedIn profiles with advanced filters (location, connection type, current company, position)
+- Search Linkedin profiles with advanced filters (location, connection type, current company, position)
 - Extract complete profile information (experience, education, skills, contact details)
 - Get company details and information
 - Retrieve incoming and outgoing connection requests
@@ -19,14 +19,14 @@ Effortless LinkedIn scraping with zero detection. Extract, export, and automate
 
 ```bash
 # Clone the repo
-github.com/vertexcover-io/linkedin-mcp-py
-cd linkedin-mcp-py
+github.com/vertexcover-io/linkedin-spider
+cd linkedin-spider
 # Install with uv
 uv sync
 ```
 
 > [!NOTE]
-> **Authentication Update:** LinkedIn has enhanced their anti-bot mechanisms, temporarily affecting cookie-based authentication. We recommend using the email/password authentication method for reliable access. We are actively working on restoring full cookie authentication support.
+> **Authentication Update:** Linkedin has enhanced their anti-bot mechanisms, temporarily affecting cookie-based authentication. We recommend using the email/password authentication method for reliable access. We are actively working on restoring full cookie authentication support.
 
 ## Different ways to use it
 
@@ -35,15 +35,15 @@ uv sync
 Perfect for integration into your existing Python applications:
 
 ```python
-from linkedin_scraper import LinkedInScraper, ScraperConfig
+from linkedin_scraper import LinkedinSpider, ScraperConfig
 
 config = ScraperConfig(headless=True, page_load_timeout=30)
 ```
 
 ```python
 # Authenticate (use either email/password or cookie).
 # Authentication is mostly done once and the session is saved in the chrome profile
-scraper = LinkedInScraper(
+scraper = LinkedinSpider(
     email="your_email@example.com",
     password="your_password",
     config=config
@@ -138,9 +138,9 @@ For more examples : [examples](./examples)
 Great for quick data extraction and scripting:
 
 ```bash
-uv run linkedin_scraper_cli search -q "product manager" -n 10 -o results.json
-uv run linkedin_scraper_cli profile -u "https://linkedin.com/in/johndoe" -o profile.json
-uv run linkedin_scraper_cli company -u "https://linkedin.com/company/openai" -o company.json
+uv run linkedin-spider-cli search -q "product manager" -n 10 -o results.json
+uv run linkedin-spider-cli profile -u "https://linkedin.com/in/johndoe" -o profile.json
+uv run linkedin-spider-cli company -u "https://linkedin.com/company/openai" -o company.json
 ```
 
 ### 3. MCP Server
@@ -182,7 +182,7 @@ TRANSPORT=sse uv run linkedin_mcp
 
 ```bash
 # Add to Claude Code
-claude mcp add linkedin-scraper --transport sse <server-url> 
+claude mcp add linkedin-spider --transport sse <server-url> 
 # Example server URL format: http://localhost:8080/sse
 ```
 
@@ -208,7 +208,7 @@ Then add this to your Claude Desktop configuration:
 ```json
 {
   "mcpServers": {
-    "linkedin-scraper": {
+    "linkedin-spider": {
       "command": "docker",
       "args": [
         "run", "--rm", "-i",
@@ -223,32 +223,6 @@ Then add this to your Claude Desktop configuration:
 }
 ```
 
-##### Option 2: Direct Installation (Alternative)
-
-If you prefer not to use Docker, you can install directly:
-
-```bash
-# Install globally
-uv tool install --editable .
-```
-
-Then configure Claude Desktop:
-```json
-{
-  "mcpServers": {
-    "linkedin-scraper": {
-      "command": "linkedin-mcp",
-      "args": ["stdio"],
-      "env": {
-        "LINKEDIN_EMAIL": "your_email@example.com",
-        "LINKEDIN_PASSWORD": "your_password",
-        "HEADLESS": "true"
-      }
-    }
-  }
-}
-```
-
 
 
 ## Docker Development & Testing
@@ -282,22 +256,22 @@ docker run --rm -i -e TRANSPORT=stdio --env-file .env linkedin-mcp
 
 ## Authentication Methods
 
-### Method 1: LinkedIn Cookie
+### Method 1: Linkedin Cookie
 
-1. Login to LinkedIn in your browser
+1. Login to Linkedin in your browser
 2. Open Developer Tools (F12)
 3. Go to Application/Storage → Cookies → linkedin.com
 4. Copy the `li_at` cookie value
 5. Use it in your code:
 
 ```python
-scraper = LinkedInScraper(li_at_cookie="your_cookie_value")
+scraper = LinkedinSpider(li_at_cookie="your_cookie_value")
 ```
 
 ### Method 2: Email & Password (Recommended)
 
 ```python
-scraper = LinkedInScraper(
+scraper = LinkedinSpider(
     email="your_email@example.com",
     password="your_password"
 )
@@ -315,11 +289,11 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 This tool is for personal use only. Please:
 
-- Respect LinkedIn's Terms of Service
+- Respect Linkedin's Terms of Service
 - Use reasonable rate limits
 - Don't spam or harass users
 - Be responsible with the data you collect
 
 ---
 
-**Ready to extract LinkedIn data like a pro?** Star this repo and start scraping!
+**Ready to extract Linkedin data like a pro?** Star this repo and start scraping!