https://github.com/lucmq/gcp-project-id

Access your Google Cloud project ID and related configuration.
https://github.com/lucmq/gcp-project-id

config gcp gcp-project google-cloud project-id

Last synced: about 2 months ago
JSON representation

Access your Google Cloud project ID and related configuration.

• Host: GitHub
• URL: https://github.com/lucmq/gcp-project-id
• Owner: lucmq
• License: mit
• Created: 2024-02-22T00:45:36.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-06-06T12:54:28.000Z (8 months ago)
• Last Synced: 2024-06-21T14:31:01.227Z (7 months ago)
• Topics: config, gcp, gcp-project, google-cloud, project-id
• Language: Go
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gcp-project-id

[![Go Reference](https://pkg.go.dev/badge/github.com/lucmq/gcp-project-id.svg)](https://pkg.go.dev/github.com/lucmq/gcp-project-id)

[![Go Report Card](https://goreportcard.com/badge/github.com/lucmq/gcp-project-id)](https://goreportcard.com/report/github.com/lucmq/gcp-project-id)

[![Go Coverage](https://github.com/lucmq/gcp-project-id/wiki/coverage.svg)](https://raw.githack.com/wiki/lucmq/gcp-project-id/coverage.html)

[![DeepSource](https://app.deepsource.com/gh/lucmq/gcp-project-id.svg/?label=active+issues&show_trend=false&token=UNFmjB4lDK3-JBb8f0AcsfsQ)](https://app.deepsource.com/gh/lucmq/gcp-project-id/)

Access your Google Cloud project ID and related configuration.

Works in the cloud and local development environments, as it can retrieve the project

ID configured within the `gcloud` CLI.

## Installation

To use this package in your Go project, you can install it using `go get`:

```bash

go get github.com/lucmq/gcp-project-id

```

## Usage

Here's how you can use the project package to retrieve a Google Cloud project ID:

```go

package main

import (

	"fmt"

	"github.com/lucmq/gcp-project-id/project"

)

func main() {

	// Retrieve the default project ID with default options

	projectID := project.ID()

	fmt.Println("Default Project ID:", projectID)

}

```

With custom options:

```go

package main

import (

	"fmt"

	"time"

	

	"github.com/lucmq/gcp-project-id/project"

)

func main() {

	// Customize options (e.g., timeout, scopes, strict mode)

	options := project.Options{

		Timeout: 10 * time.Second,

		Scopes:  []string{"https://www.googleapis.com/auth/compute"},

		Strict:  true,

	}

	// Retrieve the project ID with custom options

	projectID := project.ID(options)

	fmt.Println("Default Project ID:", projectID)

}

```

# Contributing

Contributions to this package are welcome! If you find any issues or have suggestions

for improvements, please feel free to open an issue or submit a pull request.

# License

This project is licensed under the MIT License - see the LICENSE file for details.