Skip to main content

A tool for uploading and managing projects in Claude.ai

Project description

Claude-Pyrojects

sorry, I suck at naming

Claude-Pyrojects is a Python package that allows you to easily upload your entire project directory to a Claude project. By doing this, Claude can access your project files and utilize them effectively. This is particularly useful for leveraging Claude's capabilities in understanding and interacting with your codebase.

Special thanks to the creators of ClaudeAPI, specifically n0kovo's branch

Features

  • Initialize Project: Set up your project directory for integration with Claude by creating a .ignore file to specify folders and files that should be excluded from the upload.
  • Create Claude Project: Automatically create a new project in Claude and upload the entire directory structure and files.
  • Update Project: Reinitialize your Claude project by clearing existing files and re-uploading the current state of your project directory.
  • Flexible Ignoring: Customize which folders, file types, and specific file names to exclude using the claude_pyrojects.ignore file.

Prerequisites

  • A Claude account (Claude Pro is recommended for the best experience).
  • Python 3.6 or higher.
  • An active Claude session key, which can be obtained from your Claude account.

Installation

To install Claude-Pyrojects, use pip:

pip install claude-pyrojects

Usage

Step 1: Initialize the Project

The first step is to initialize the project. This will create the necessary configuration files, including the ignore file (claude_pyrojects.ignore) and save your session key.

Refer to this on how to get your session key.

python -m claude-pyrojects.cli init -K "your_session_key"

Step 2: Create a New Project in Claude

Once your project is initialized, you can create a new project in Claude. This will upload your entire project directory, excluding any files and folders specified in the ignore file.

python -m claude-pyrojects.cli create -N "Your Project Name"

Step 3: Update the Claude Project

As your project evolves, you might need to re-upload it to Claude to reflect the latest changes. The update command reinitializes the project by clearing all existing files and re-uploading the current state of your directory.

python -m claude-pyrojects.cli update

Customizing the Ignore File

The claude_pyrojects.ignore file allows you to specify folders, file extensions, and specific filename substrings to exclude from the upload process.

Example claude_pyrojects.ignore:

ignore_folders=[".venv", ".idea", ".vscode"]
ignore_file_extensions=["pdf", "jpg", "png", "pyc"]
ignore_name_includes=["claude_pyrojects"]
  • ignore_folders: List of folders to be ignored.
  • ignore_file_extensions: List of file extensions to be ignored.
  • ignore_name_includes: List of substrings that, if found in a filename, will cause the file to be ignored.

Changing the Session Key

In order to change the session key, simply look for the claude_pyrojects.key file and replace it's contents with your new key

Planned Features

  • GitHub Integration: A GitHub app that automatically updates the Claude project whenever changes are pushed to the repository.

Disclaimer

This project provides an unofficial API for Claude AI and is not affiliated with or endorsed by Claude AI or Anthropic. Use it at your own risk.

Please refer to the official Claude AI documentation for more information on how to use Claude AI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claude-pyrojects-0.1.2.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

claude_pyrojects-0.1.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file claude-pyrojects-0.1.2.tar.gz.

File metadata

  • Download URL: claude-pyrojects-0.1.2.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for claude-pyrojects-0.1.2.tar.gz
Algorithm Hash digest
SHA256 db633ff2a1c10e7133ff2f3e47e665ae099790defcdca8d569c3a6a5a9780d84
MD5 b6261e887a9cc09fcff033ac2cc8fa45
BLAKE2b-256 41ba1c3fa7128ba42e7b0dcd5f1dd53a0544868ef7a4b03ea54976ed403d3be3

See more details on using hashes here.

File details

Details for the file claude_pyrojects-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for claude_pyrojects-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 865808da84929865daccbb3844121cdf4739c0540b8fe148358f70b27aa0f614
MD5 47c8539a69cd0251ab0ca4ceb859a606
BLAKE2b-256 5ee24d7f5bb4898fcf71da3b18884a1e67a3c35b4ed5c1765380a672a049428f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page